rusdox 1.0.0

Generate DOCX and PDF from YAML at Rust speed.
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

//! `RusDox` is a focused Rust library for building, reading, and saving
//! Microsoft Word `.docx` documents.
//!
//! The crate models the document body with strongly typed paragraphs, runs,
//! and tables while using fast ZIP and XML primitives internally.
//!
//! # Example
//!
//! ```rust
//! use rusdox::{Document, Paragraph, Run};
//!
//! let mut document = Document::new();
//! document.push_paragraph(
//!     Paragraph::new()
//!         .add_run(Run::from_text("Hello ").bold())
//!         .add_run(Run::from_text("RusDox").italic()),
//! );
//!
//! assert_eq!(document.paragraphs().count(), 1);
//! ```

#![deny(missing_docs)]
#![deny(rustdoc::broken_intra_doc_links)]

pub mod batch;
pub mod config;
mod document;
mod error;
mod io_utils;
mod layout;
mod limits;
mod metadata;
mod package_validate;
mod paragraph;
pub mod parity;
pub mod protocol;
pub mod renderer;
mod run;
pub mod schema;
mod source;
/// Versioned YAML, JSON, and TOML document specification types and builders.
pub mod spec;
mod spec_expand;
pub mod studio;
mod style;
mod table;
mod template;
/// Semantic validation diagnostics for document specifications and configuration.
pub mod validate;
mod visual;
mod xml_utils;

pub use batch::{BatchItemResult, BatchLimits, BatchRenderer, BatchRequest, BatchStatus};
pub use document::{Document, DocumentBlockRef, DocumentMode};
pub use error::{DocxError, Result};
pub use io_utils::atomic_write as atomic_write_file;
pub use layout::{HeaderFooter, PageNumberFormat, PageNumbering, PageOrientation, PageSetup};
pub use limits::InputLimits;
pub use metadata::DocumentMetadata;
pub use package_validate::{
    validate_docx_package, validate_docx_package_with_limits, validate_docx_reader_with_limits,
    PackageValidationReport,
};
pub use paragraph::{Paragraph, ParagraphAlignment, ParagraphList, ParagraphListKind};
pub use renderer::{
    CancellationToken, NativeRenderer, RenderRequest, RenderSource, RenderedDocument, Renderer,
    RendererValidation, SpecFormat, RENDERER_API_VERSION,
};
pub use run::{Run, RunField, RunProperties, UnderlineStyle, VerticalAlign};
pub use schema::{document_spec_schema, document_spec_schema_pretty, DOCUMENT_SPEC_SCHEMA_ID};
pub use source::{attach_source_spans, attach_source_spans_from_str};
pub use style::{
    ParagraphStyle, ParagraphStyleProperties, RunStyle, RunStyleProperties, Stylesheet, TableStyle,
    TableStyleProperties,
};
pub use table::{
    Border, BorderStyle, Table, TableBorders, TableCell, TableCellProperties, TableProperties,
    TableRow, TableRowProperties,
};
pub use template::{
    DocxTemplate, TemplateDiagnostic, TemplateDiagnosticSeverity, TemplateInspection,
    TemplatePlaceholder, TemplateRenderReport, TEMPLATE_SYNTAX_VERSION,
};
pub use validate::{
    validate_config, validate_spec, validate_spec_with_config, SourceSpan, ValidationIssue,
    ValidationReport, ValidationSeverity,
};
pub use visual::{Visual, VisualFormat, VisualKind, VisualSizing, VisualSource};