xl3-core 0.1.0

Pure-Rust XLSX template rendering engine (acceleration core for xl3)
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

//! xl3-core — pure-Rust XLSX template rendering engine.
//!
//! Reads an Excel template plus a data workbook, evaluates the XTL
//! expressions inside template cells, and emits a rendered XLSX
//! buffer. This is the same engine that powers the `xl3-wasm` npm
//! package; it can also be embedded directly in Rust CLIs, Tauri
//! desktop apps, or server-side batch jobs.
//!
//! # Quick start
//!
//! ```no_run
//! use xl3_core::render_from_bytes_to_files;
//!
//! let template = std::fs::read("template.xlsx").unwrap();
//! let data = std::fs::read("data.xlsx").unwrap();
//! let files = render_from_bytes_to_files(&template, &data).unwrap();
//! std::fs::write(&files[0].filename, &files[0].data).unwrap();
//! ```
//!
//! # Pipeline
//!
//! 1. [`plan`] — parse the template workbook + `__config__` sheet
//!    into a [`WorkbookPlan`] of static and expansion rows.
//! 2. [`source`] — read the data workbook into row records.
//! 3. [`render`] — walk the plan, evaluating each cell through
//!    [`eval`], and emit cells through [`output`].
//!
//! See the parent repository's `PLAN.md` for the broader roadmap.

pub mod directives;
pub mod errors;
pub mod eval;
pub mod functions;
pub mod introspect;
pub mod manifest;
pub mod output;
pub mod output_model;
pub mod plan;
pub mod render;
pub mod source;
pub mod styles;
pub mod value;

pub use calamine;
pub use rust_xlsxwriter;

pub use errors::{is_xtl_error, XtlError};
pub use introspect::{
    preview, preview_bytes, read_template_inputs, read_template_inputs_bytes, InputKind,
    InputSpec, PreviewFile, PreviewResult, PreviewSheet, PreviewSource,
};
pub use manifest::{
    AlignmentSpec, ColumnWidth, FillPattern, FillSpec, FontSpec, HorizontalAlign,
    StyleManifest, StyleSpec, VerticalAlign,
};
pub use output_model::{OutputFile, XtlWarning};
pub use plan::{parse_template, parse_template_bytes, CellSource, RowPlan, SheetPlan, WorkbookPlan};
pub use render::{
    render, render_from_bytes_to_files, render_from_bytes_to_files_full,
    render_from_bytes_to_files_with_inputs, render_to_files,
};
pub use source::{CalamineSourceReader, SourceData, SourceReader};
pub use value::Value;