Expand description
Public facade for easy DOC/DOCX document operations.
Modules§
- content_
renderer - 语义模型渲染器 — 将
DocumentContent转换为 docx-rs 文档。 - prelude
- Prelude module with the most commonly used types.
Structs§
- Atomic
File - 在目标文件所在目录中完成临时写入和原子替换。
- Auto
Width Strategy - 自动列宽计算策略。
- Banded
Rows Strategy - 为表格应用交替行背景色。
- Cell
Context - 单元格级写入事件的上下文。
- Cell
Data - 单个表格单元格的数据。
- Collect
Listener - 将所有项收集到
Vec<T>中的监听器，用于同步读取。 - Color
- 24 位 RGB 颜色。
- Content
Collector - 将事件流收集为
DocumentContent的默认实现。 - Conversion
Warning - 转换过程中发生的可恢复降级说明。
- Converter
Registry - 持有用户注册和内置
DocConverter实例的注册表。 - DocBuilder
- 构建完整 DOCX 文档的 Fluent 构建器。
- DocEditor
- 已打开的 DOCX 文件，准备进行修改。
- DocImage
- 向文档插入图片的配置。
- DocRead
Builder - 流式文档读取的 Fluent 构建器。
- DocRead
Context - 读取监听器回调的上下文信息。
- DocWrite
Context - 文档级写入事件的上下文。
- DocWrite
Executor - 将
crate::DocBuilder渲染为物理 DOCX 文件的执行器。 - Document
Content - 与 DOC/DOCX 解析器实现无关的完整语义文档。
- Document
Image - 从文档中提取的图片及其语义信息。
- Document
List - 有序或无序的语义列表。
- Document
List Item - 列表项及其可选子列表。
- Document
Meta - DOCX 文件的文档级元数据。
- Document
Table - 保留表头和合并单元格信息的语义表格。
- Document
Table Cell - 支持嵌套块和跨行跨列的表格单元格。
- Document
Table Row - 语义表格中的一行。
- Document
Text Run - 带常用富文本属性的文本片段。
- Docx
SaxReader - 基于 SAX 风格 XML 解析的流式 DOCX 读取器。
- EasyDoc
- Static factory — the single entry point for all
easydocoperations. - Extracted
Asset - 从源文档提取并写入磁盘的资源。
- Fill
Config - 控制模板填充行为的配置。
- Font
Config - 文本片段的字体配置。
- Image
Data - 图片载荷及元数据。
- Markdown
Builder - 面向使用者的 DOC/DOCX 到 Markdown 流式配置入口。
- Markdown
Options - DOC/DOCX 到 Markdown 的转换选项。
- Markdown
Result - Markdown 转换正文、资源和降级信息的完整结果。
- Package
Limits - 防止畸形或恶意 OOXML ZIP 包耗尽资源的限制。
- Package
Rewriter - 在保留未修改二进制条目的前提下重写 OOXML ZIP 包。
- Paragraph
- 由文本片段组成的段落。
- Paragraph
Context - 段落级写入事件的上下文。
- Paragraph
Style - 段落级格式化。
- RichRun
- 富文本单元格中的单个格式化文本片段。
- RowData
- 单个表格行的数据。
- Run
- 段落内的格式化文本片段。
- Table
- 从类型化数据构建的表格。
- Table
Column - 表格中单列的描述符。
- Table
Data - 读取过程中从文档提取的完整表格数据。
- Table
Style - 表格级格式化配置。
- Table
Write Builder - 将类型化
Vec<T>写入 DOCX 表格的 Fluent 构建器。 - Table
Write Context - 表格级写入事件的上下文。
- Table
Write Executor - Executor for one-shot table writes.
- Template
Fill Builder - Builder for template fill operations.
Enums§
- DocError
- 库统一错误枚举。
- DocValue
- 通用文档值 – Rust 类型与 DOCX 内容之间的桥梁。
- Document
Block - 文档中的后端无关块级元素。
- Document
Event - 文档解析过程中产生的事件。
- Document
Format - Supported document formats.
- Document
Section - 文档分区类型，用于 Section 块。
- Error
Action - 读取错误发生时的动作。
- Fill
Direction - 集合展开的填充方向。
- Heading
Level - 结构化文档的标题级别。
- Horizontal
Alignment - 段落对齐选项。
- Placeholder
- 在 DOCX 文档中检测到的占位符。
- View
Mode - 选择如何将
DocumentContent渲染为字符串。
Traits§
- DocConverter
- Rust 类型
T与DocValue之间的双向转换。 - DocRead
Listener - 流式读取过程中接收已解析内容的监听器。
- DocWrite
Handler - 写入生命周期拦截器 – 在文档、段落、表格和单元格级别提供钩子。
- Document
Reader - 统一的文档读取接口。
- DocxRow
- 结构体与 DOCX 表格行的双向映射。
- Event
Sink - 事件消费回调接口。
Functions§
- detect_
format - Detects the document format from file extension and magic bytes.
- render_
view - 按照指定的
ViewMode将DocumentContent渲染为字符串。
Type Aliases§
- Easy
DocFactory - Java-compatible alias for
EasyDoc. - Result
- easydoc-rust 标准
Result类型别名。
Derive Macros§
- Docx
RowDerive - 派生静态表格列元数据和双向行转换。