11 releases (4 stable)

1.1.2 Apr 27, 2020
1.1.1 Apr 7, 2020
1.1.0 Mar 25, 2020
0.2.1 Nov 8, 2019
0.1.0 Aug 17, 2018

#655 in Parser implementations

Download history 25/week @ 2022-03-04 32/week @ 2022-03-11 71/week @ 2022-03-18 13/week @ 2022-03-25 19/week @ 2022-04-01 9/week @ 2022-04-08 9/week @ 2022-04-15 16/week @ 2022-04-22 50/week @ 2022-04-29 66/week @ 2022-05-06 193/week @ 2022-05-13 50/week @ 2022-05-20 96/week @ 2022-05-27 88/week @ 2022-06-03 14/week @ 2022-06-10 8/week @ 2022-06-17

208 downloads per month

MIT license

105KB
3K SLoC

GitHub Workflow Status Crates.io Document

docx

A Rust library for parsing and generating docx files.

Document

License

MIT


lib.rs:

A Rust library for parsing and generating docx files.

Create a new document

Use Docx::default to create a new empty Docx, then use Docx::write_file for saving it to a file.

use docx::document::Paragraph;
use docx::Docx;

let mut docx = Docx::default();

// create a new paragraph and insert it
let para = Paragraph::default().push_text("Lorem Ipsum");
docx.document.push(para);

docx.write_file("demo.docx").unwrap();

Also see: Docx::write.

Reading from files

Use DocxFile::from_file to extract content from docx files, then use DocxFile::parse to generate a Docx struct.

use docx::document::Paragraph;
use docx::DocxFile;

let docx = DocxFile::from_file("origin.docx").unwrap();
let mut docx = docx.parse().unwrap();

let para = Paragraph::default().push_text("Lorem Ipsum");
docx.document.push(para);

docx.write_file("origin_appended.docx").unwrap();

To reduce allocations, DocxFile::parse returns a Docx struct contains references to DocxFile itself. It means you have to make sure that DocxFile lives as long as its returned Docx:

use docx::DocxFile;

let mut docx_option = None;
{
    let docx_file = DocxFile::from_file("foo.docx").unwrap();
    let mut docx = docx_file.parse().unwrap();
    docx_option = Some(docx);
    // `docx_file` gets dropped here and code fails to compile
}
docx_option.unwrap().write_file("foo.docx").unwrap();

Also see: DocxFile::from_reader.

Similar Projects

bokuweb/docx-rs: A .docx file writer with Rust/WebAssembly.

License

MIT

Dependencies

~2–2.8MB
~51K SLoC