Expand description
这个文件可以理解成“库的总入口”。
别的 Rust 项目接入 pdfxml 时,最先接触到的通常就是这里。
因为这里决定了两件事:
- 哪些模块对外公开
- 外部最常用的类型和函数有哪些
如果你只是想会用这个库,不想一下子钻进所有实现细节, 那直接从这个文件看就够了。
你可以把这里当成“对外使用说明 + API 门面”:
- 想读 XFDF:看
load_xfdf - 想从 PDF 读注释:看
load_annotations_from_pdf - 想把注释导出成 PDF:看
export_annotations - 想自己细调导出行为:看
PdfAnnotationExporter
建议阅读顺序:
- 先看下面的
pub mod ...,知道项目分成哪几块 - 再看
pub use ...,知道外部能直接拿到哪些 API - 最后看几个顶层函数,理解最常见调用流程
Re-exports§
pub use error::PdfXmlError;pub use error::Result;pub use pdf::PdfAnnotationExporter;pub use xfdf::XfdfDocument;pub use xfdf::XfdfField;pub use annotation::*;
Modules§
- annotation
- 注释数据结构模块。
- error
- 统一错误类型模块。
- PDF 读写模块。
- xfdf
- XFDF/XML 解析模块。
Functions§
- export_
annotations - 把已经解析好的注释导出成 PDF。
- export_
pdf_ annotations_ to_ xfdf - 把 PDF 里的注释直接导出成一个标准 XFDF 文件。
- load_
annotations_ from_ pdf - 从 PDF 中读取注释,并转换成项目统一使用的
XfdfDocument。 - load_
xfdf - 从磁盘读取一个 XFDF 文件,并解析成
XfdfDocument。