Struct COSDocument 

pub struct COSDocument {
    pub objects: BTreeMap<ObjectId, COSObject>,
    pub trailer: COSDictionary,
    pub version: String,
    pub max_object_number: u32,
    pub dirty_objects: BTreeSet<ObjectId>,
}

Low-level PDF document holding all COS objects and the trailer dictionary.

Fields

objects: BTreeMap<ObjectId, COSObject>

trailer: COSDictionary

version: String

max_object_number: u32

dirty_objects: BTreeSet<ObjectId>

Implementations

impl COSDocument

pub fn new() -> Self

pub fn allocate_id(&mut self) -> ObjectId

Allocates a new, unique object id with generation 0.

pub fn add_object<T: Into<COSObject>>(&mut self, obj: T) -> ObjectId

Stores a new object and returns its allocated ObjectId.

pub fn set_object<T: Into<COSObject>>(&mut self, id: ObjectId, obj: T)

Sets or replaces an object with a specific ObjectId and marks it dirty.

pub fn get_object(&self, id: ObjectId) -> Option<&COSObject>

Retrieves an object by its ObjectId.

pub fn get_object_mut(&mut self, id: ObjectId) -> Option<&mut COSObject>

Retrieves a mutable reference to an object by its ObjectId and marks it dirty.

pub fn resolve<'a>(&'a self, obj: &'a COSObject) -> &'a COSObject

Resolves an object: if it’s a Reference, fetches the target object; otherwise returns the object.

pub fn get_resolved(&self, id: ObjectId) -> PdfResult<&COSObject>

Resolves a reference or returns error if not found.

pub fn get_catalog(&self) -> Option<&COSDictionary>

Gets the Document Catalog dictionary (/Root).

pub fn get_catalog_mut(&mut self) -> Option<&mut COSDictionary>

Gets mutable Document Catalog dictionary.

pub fn get_info(&self) -> Option<&COSDictionary>

Gets Document Information dictionary (/Info).

pub fn clear_dirty(&mut self)

Clears the dirty tracking set (e.g. after saving).

Trait Implementations

impl Clone for COSDocument

fn clone(&self) -> COSDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for COSDocument

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

Formats the value using the given formatter.

impl Default for COSDocument

fn default() -> Self

Returns the “default value” for a type.