Skip to main content

pdf_forms/
lib.rs

1#![doc = include_str!("../README.md")]
2#![forbid(unsafe_code)]
3#![deny(clippy::all)]
4// lopdf vendored source carries cfg-flag branches for features we don't
5// enable (async, jiff, time), dead newtype fields, nested if-let chains,
6// and a few pedantic style patterns.  Allow them at the crate level rather
7// than annotating dozens of vendored files.
8#![allow(
9    unexpected_cfgs,
10    dead_code,
11    clippy::collapsible_if,
12    clippy::useless_format,
13    clippy::manual_is_multiple_of
14)]
15
16pub mod acroform;
17pub mod content;
18pub mod encryption;
19pub mod filters;
20pub mod overlay;
21pub mod sanitize;
22pub mod signature;
23pub mod xobject;
24pub mod xref;
25
26pub use acroform::{AcroField, AcroFont, AcroFormFiller, FieldMap, FieldValue, WidgetType};
27pub use overlay::{OverlayComposite, OverlayContent, OverlayRegion};
28pub use signature::SignatureStamp;
29
30#[macro_use]
31mod object;
32mod document;
33mod incremental_document;
34mod lopdf_document;
35
36mod bookmarks;
37mod cmap_section;
38mod common_data_structures;
39mod compress;
40mod creator;
41mod datetime;
42mod destinations;
43mod encodings;
44mod error;
45mod image;
46mod lopdf_error;
47mod outlines;
48mod processor;
49mod toc;
50mod writer;
51
52mod load_options;
53mod object_stream;
54mod parser;
55mod parser_aux;
56mod reader;
57mod save_options;
58
59mod font;
60mod resources;
61
62pub use document::{PageSize, PdfDocument, Rect};
63pub(crate) use lopdf_document::Document;
64pub use object::{Dictionary, Object, ObjectId, Stream, StringFormat};
65
66pub use bookmarks::Bookmark;
67pub use common_data_structures::{decode_text_string, text_string};
68pub use destinations::Destination;
69pub use encodings::{Encoding, encode_utf8, encode_utf16_be};
70pub use encryption::{EncryptionState, EncryptionVersion, Permissions};
71pub use error::PdfError;
72pub use incremental_document::IncrementalDocument;
73pub use load_options::{FilterFunc, LoadOptions};
74pub(crate) use lopdf_error::{Error, Result};
75pub use object_stream::{ObjectStream, ObjectStreamBuilder, ObjectStreamConfig};
76pub use outlines::Outline;
77pub use reader::{PdfMetadata, Reader};
78pub use sanitize::Sanitizer;
79pub use save_options::{SaveOptions, SaveOptionsBuilder};
80pub use toc::Toc;
81
82pub use parser_aux::substr;
83pub use parser_aux::substring;
84
85pub use font::FontData;
86
87/// Internal lopdf types exposed for integration-test fixture generation.
88///
89/// This module is `#[doc(hidden)]` and unstable. Do not depend on it in
90/// production code — it may be removed in any release.
91#[doc(hidden)]
92pub mod _lopdf {
93    pub use crate::lopdf_document::Document;
94    pub use crate::lopdf_error::Error;
95    pub use crate::object::{Dictionary, Object, ObjectId, Stream, StringFormat};
96}