7 releases

0.1.9 Dec 17, 2024
0.1.8 May 21, 2024
0.1.6 Dec 31, 2023
0.1.5 Mar 30, 2023
0.1.3 Jul 17, 2022

#590 in Parser implementations

Download history 310/week @ 2024-12-29 287/week @ 2025-01-05 661/week @ 2025-01-12 603/week @ 2025-01-19 514/week @ 2025-01-26 563/week @ 2025-02-02 531/week @ 2025-02-09 439/week @ 2025-02-16 546/week @ 2025-02-23 770/week @ 2025-03-02 723/week @ 2025-03-09 1073/week @ 2025-03-16 2767/week @ 2025-03-23 4658/week @ 2025-03-30 7662/week @ 2025-04-06 9343/week @ 2025-04-13

24,757 downloads per month
Used in 4 crates

MIT license

1MB
11K SLoC

GitHub Workflow Status Crates.io Document

docx

A Rust library for parsing and generating docx files.

fork of https://github.com/PoiScript/docx-rs

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_rust::document::Paragraph;
use docx_rust::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_rust::document::Paragraph;
use docx_rust::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_rust::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–3MB
~60K SLoC