Struct Reference 

pub struct Reference<T> {
    pub id: ReferenceId,
    /* private fields */
}

A PDF reference to an indirect object.

In Livre, the Reference object is generic over the type of the indirect object, making the entire interface type-safe. You can “opt out” of type safety by using an Object type, which can represent any PDF object.

PDF documents resort to a “random access” strategy to limit repetition and split large objects into smaller atoms. Indirect objects are also used when a property cannot be known in advance. For instance, in the general case a PDF generator may choose to represent the Length key in the Stream dictionary with an indirect object to allow writing the content to disk without having to know the serialised length in advance.

To that end, some objects are represented by a Reference, indicating the object ID as well as the generation number. These are represented together in Livre, through the ReferenceId type.

In practice, it looks like the generation number is not useful unless we are interested in retrieving the PDF history. Livre tracks it in case we want to develop that capability down the line.

Fields

id: ReferenceId

Trait Implementations

impl<T> Clone for Reference<T>

We need to implement the Clone trait manually because of the automatic trait bound on T.

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Reference<T>

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

Formats the value using the given formatter.

impl<T> Extract<'_> for Reference<T>

fn extract(input: &mut &BStr) -> PResult<Self>

fn recognize(input: &mut &'de BStr) -> PResult<&'de [u8]>

Consume the input, without trying to parse.

impl<T> From<(usize, u16)> for Reference<T>

fn from(id: (usize, u16)) -> Self

Converts to this type from the input type.

impl From<Reference<Object>> for Object

fn from(value: Reference<Object>) -> Self

Converts to this type from the input type.

impl<T> From<ReferenceId> for Reference<T>

fn from(id: ReferenceId) -> Self

Converts to this type from the input type.

impl<T: PartialEq> PartialEq for Reference<T>

fn eq(&self, other: &Reference<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Copy for Reference<T>

impl<T: Eq> Eq for Reference<T>

impl<T> StructuralPartialEq for Reference<T>