Skip to main content

Crate linch_docx_rs

Crate linch_docx_rs 

Source
Expand description

§linch-docx-rs

A reliable DOCX reading and writing library for Rust.

§Features

  • Read and write DOCX files
  • Round-trip preservation (unknown elements are kept intact)
  • Simple, pythonic API inspired by python-docx

§Quick Start

use linch_docx_rs::Document;

// Open a document
let doc = Document::open("example.docx")?;

// Read paragraphs
for para in doc.paragraphs() {
    println!("{}", para.text());
}

// Create a new document
let mut doc = Document::new();
doc.add_paragraph("Hello World!");
doc.save("output.docx")?;

Re-exports§

pub use document::Alignment;
pub use document::Comment;
pub use document::Comments;
pub use document::CoreProperties;
pub use document::DocDefaults;
pub use document::Document;
pub use document::HeaderFooter;
pub use document::ImageData;
pub use document::Indentation;
pub use document::InlineImage;
pub use document::LineSpacing;
pub use document::Note;
pub use document::Notes;
pub use document::PageMargin;
pub use document::PageOrientation;
pub use document::PageSize;
pub use document::Paragraph;
pub use document::Run;
pub use document::RunContent;
pub use document::SectionProperties;
pub use document::Style;
pub use document::StyleType;
pub use document::Styles;
pub use document::Table;
pub use document::TableAlignment;
pub use document::TableCell;
pub use document::TableRow;
pub use document::TableWidth;
pub use document::TemplateContext;
pub use document::TextLocation;
pub use document::VerticalAlignment;
pub use error::Error;
pub use error::Result;
pub use opc::Package;
pub use opc::Part;
pub use opc::PartUri;
pub use units::Cm;
pub use units::Emu;
pub use units::HalfPt;
pub use units::Inch;
pub use units::Mm;
pub use units::Pt;
pub use units::Twip;

Modules§

document
Document model - high-level API for DOCX documents
error
Error types for linch-docx-rs
opc
Open Packaging Convention (OPC) implementation
units
Measurement unit types for OOXML
xml
XML utilities and raw element preservation for round-trip support