Struct PdfDocument

Source

pub struct PdfDocument {
    pub version: String,
    pub objects: Vec<PdfObject>,
    pub pages: Vec<PdfPage>,
    pub info: PdfInfo,
    pub image_xobjects: Vec<ImageXObject>,
    pub gradients: Vec<PdfGradient>,
    pub ext_g_states: Vec<PdfExtGState>,
    pub outline: Option<PdfOutline>,
    pub font_manager: FontManager,
    pub encryption: Option<EncryptionDict>,
    pub file_id: Option<Vec<u8>>,
    pub compliance: PdfCompliance,
}

Expand description

PDF document structure

Fields§

§version: String

PDF version (e.g., “1.4”)

§objects: Vec<PdfObject>

Objects in the PDF

§pages: Vec<PdfPage>

Page tree

§info: PdfInfo

Document info

§image_xobjects: Vec<ImageXObject>

Image XObjects (shared resources)

§gradients: Vec<PdfGradient>

Gradient shading patterns (shared resources)

§ext_g_states: Vec<PdfExtGState>

Extended Graphics States for transparency

§outline: Option<PdfOutline>

Document outline (bookmarks)

§font_manager: FontManager

Font manager for embedded fonts

§encryption: Option<EncryptionDict>

Encryption settings (if set, all streams/strings will be encrypted)

§file_id: Option<Vec<u8>>

File ID for the /ID entry in the trailer (required for encryption)

§compliance: PdfCompliance

PDF compliance mode (Standard, PDF/A-1b, PDF/UA-1, or both)

Implementations§

Source §

impl PdfDocument

Source

pub fn new() -> Self

Create a new PDF document

Source

pub fn set_compliance(&mut self, compliance: PdfCompliance) -> Result<()>

Set the PDF compliance mode

§Errors

Returns an error if PDF/A compliance is requested together with encryption, since PDF/A-1b (ISO 19005-1) forbids encryption.

Source

pub fn add_page(&mut self, page: PdfPage)

Add a page to the document

Source

pub fn add_image_xobject(&mut self, xobject: ImageXObject) -> usize

Add an image XObject to the document and return its index

Source

pub fn add_gradient(&mut self, gradient: Gradient) -> usize

Add a gradient shading pattern to the document and return its index

The gradient will be registered as a PDF shading pattern resource. Returns the index that can be used to reference this gradient.

Source

pub fn add_ext_g_state( &mut self, fill_opacity: f64, stroke_opacity: f64, ) -> usize

Add an ExtGState for opacity/transparency and return its index

Creates an Extended Graphics State dictionary with the specified opacity values. Returns the index that can be used to reference this graphics state.

§Arguments

fill_opacity - Opacity for fill operations (0.0 = transparent, 1.0 = opaque)
stroke_opacity - Opacity for stroke operations (0.0 = transparent, 1.0 = opaque)

Source

pub fn set_outline(&mut self, outline: PdfOutline)

Set the document outline (bookmarks)

Source

pub fn set_encryption( &mut self, encryption: EncryptionDict, file_id: Vec<u8>, ) -> Result<()>

Set encryption for the document

When encryption is set, to_bytes() will encrypt all content streams and string objects, and include the /Encrypt dictionary in the trailer.

§Errors

Returns an error if PDF/A compliance mode is active, since PDF/A-1b (ISO 19005-1 §6.1.1) forbids encryption.

Source

pub fn embed_font(&mut self, font_data: Vec<u8>) -> Result<usize>

Embed a TrueType font and return its index

§Arguments

font_data - Raw bytes of the TTF/OTF font file

§Returns

Font index that can be used with add_text_with_font

Source

pub fn to_bytes(&self) -> Result<Vec<u8>>

Generate PDF bytes

Trait Implementations§

Source §

impl Default for PdfDocument

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl UnwindSafe for PdfDocument

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> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §