rust-docx 0.2.12

Rust parser, document model, and serializer for DOCX and legacy Word documents
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

//! Native and WebAssembly-compatible Word document parsing, modeling, and serialization.

pub mod bundle;
pub mod chart;
pub mod doc;
pub mod emf;
pub mod export;
pub mod model;
pub mod package;
pub mod parse;
pub mod review;
pub mod revision_inlines;
pub mod revisions;
pub mod serialize;
pub mod source_graph;
pub mod structured;
pub mod table_grid;
mod wmf;
pub mod xml;
mod xml_index;
pub mod zip;

pub use bundle::{
    extract_document_assets, extract_document_bundle, parse_document_bundle, DocumentBundle,
    ExtractDocumentBundleOptions,
};
pub use export::{
    export_document, ContentOverride, ExportOptions, ExportRequest, ExportedDocument, TableFormat,
};
pub use revision_inlines::{revision_inlines, InlineChange, RevisionInline};
pub use chart::{extract_chart_data, ChartCategory, ChartData, ChartPoint, ChartSeries};
pub use doc::{is_doc_format, parse_doc};
pub use model::*;
pub use package::*;
pub use parse::{build_doc_model, build_doc_model_with_options};
pub use rust_office_art::ParseOptions;
pub use review::{extract_document_review, DocumentReview, DocumentComment, CommentTarget};
pub use revisions::{
    DocumentRevision, ReviewedDocument, RevisionKind, RevisionProperties, RevisionScope,
    WordProperty,
};
pub use source_graph::{document_source_graph, DocumentSourceGraph};
pub use structured::{
    extract_document_blocks, extract_document_blocks_with_options,
    extract_document_blocks_with_revisions, BlockDetails, BlockType, DocumentBlock, DocumentWord,
    ExtractDocumentBlocksOptions, ParagraphDetails, ParagraphInline, SourceRef, StructuredDocument,
    TableCellDetails,
};

pub fn parse_document_blocks(bytes: &[u8]) -> Result<StructuredDocument, String> {
    parse_document_blocks_with_options(bytes, ExtractDocumentBlocksOptions::default())
}

pub fn parse_document_blocks_with_options(
    bytes: &[u8],
    options: ExtractDocumentBlocksOptions,
) -> Result<StructuredDocument, String> {
    let package = parse_document_bytes(bytes)?;
    Ok(extract_document_blocks_with_options(
        &build_doc_model_with_options(
            &package,
            &ParseOptions {
                include_3d_models: options.include_3d_models,
            },
        ),
        options,
    ))
}

/// Parse Word bytes and return current blocks together with their tracked revisions.
pub fn parse_document_blocks_with_revisions(
    bytes: &[u8],
    options: ExtractDocumentBlocksOptions,
) -> Result<ReviewedDocument, String> {
    let package = parse_document_bytes(bytes)?;
    Ok(extract_document_blocks_with_revisions(
        &build_doc_model_with_options(
            &package,
            &ParseOptions {
                include_3d_models: options.include_3d_models,
            },
        ),
        options,
    ))
}

pub use serialize::{
    can_preserve_image_paint_source, model_to_document_xml, serialize_doc_model, serialize_docx,
    try_serialize_doc_model, validate_image_paint_bounds,
};
pub use zip::{create_minimal_docx_package, package_to_bytes, parse_docx};

/// Parses either a DOCX (OOXML zip) or a legacy Word 97-2003 binary `.doc`
/// file, detected by magic bytes, into the same in-memory package shape.
pub fn parse_document_bytes(bytes: &[u8]) -> Result<OoxmlPackage, String> {
    if is_doc_format(bytes) {
        parse_doc(bytes)
    } else {
        parse_docx(bytes)
    }
}