Skip to main content

Document

Struct Document 

Source
pub struct Document {
    pub children: Vec<Node>,
    pub metadata: Metadata,
    pub default_page: PageConfig,
    pub fonts: Vec<FontEntry>,
    pub default_style: Option<Style>,
    pub tagged: bool,
    pub pdfa: Option<PdfAConformance>,
    pub pdf_ua: bool,
    pub embedded_data: Option<String>,
    pub flatten_forms: bool,
    pub signature: Option<SignatureConfig>,
}
Expand description

A complete document ready for rendering.

Fields§

§children: Vec<Node>

The root nodes of the document. Typically one or more Page nodes, but can also be content nodes that get auto-wrapped in pages.

§metadata: Metadata

Document metadata (title, author, etc.)

§default_page: PageConfig

Default page configuration used when content overflows or when nodes aren’t explicitly wrapped in Page nodes.

§fonts: Vec<FontEntry>

Custom fonts to register before layout. Each entry contains the font family name, base64-encoded font data, weight, and style.

§default_style: Option<Style>

Default style applied to the root of the document tree. Useful for setting a global font_family, font_size, color, etc.

§tagged: bool

Whether to produce a tagged (accessible) PDF with structure tree.

§pdfa: Option<PdfAConformance>

PDF/A conformance level. When set, forces tagged = true for “2a”.

§pdf_ua: bool

When true, the PDF claims PDF/UA-1 conformance. Forces tagged = true.

§embedded_data: Option<String>

Optional JSON string to embed as an attached file in the PDF. Enables round-tripping structured data through PDF files.

§flatten_forms: bool

When true, form field values are rendered as static content and no interactive AcroForm widgets are emitted. The resulting PDF has no fillable fields.

§signature: Option<SignatureConfig>

Digital signature configuration. When set, the rendered PDF is signed with the specified X.509 certificate and RSA private key.

Trait Implementations§

Source§

impl Clone for Document

Source§

fn clone(&self) -> Document

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Document

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Document

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Document

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,