Skip to main content

Object

Enum Object 

Source
pub enum Object {
    Null,
    Boolean(bool),
    Integer(i64),
    Real(f64),
    String(PdfString),
    Name(Name),
    Array(Vec<Object>),
    Dictionary(HashMap<Name, Object>),
    Stream {
        dict: HashMap<Name, Object>,
        data: StreamData,
    },
    Reference(ObjectId),
}
Expand description

A PDF object value.

Object::Reference holds an unresolved indirect reference — it is not recursively resolved at parse time to avoid OnceLock deadlocks.

Variants§

§

Null

The PDF null object.

§

Boolean(bool)

A boolean value.

§

Integer(i64)

An integer number.

§

Real(f64)

A real (floating-point) number.

§

String(PdfString)

A PDF string (encoding-aware).

§

Name(Name)

A PDF name.

§

Array(Vec<Object>)

An array of objects.

§

Dictionary(HashMap<Name, Object>)

A dictionary mapping names to objects.

§

Stream

A stream object with dictionary metadata and raw data reference.

Fields

§

Reference(ObjectId)

An unresolved indirect reference to another object.

Implementations§

Source§

impl Object

Source

pub fn as_bool(&self) -> Option<bool>

Returns the boolean value if this is Object::Boolean.

Source

pub fn as_i64(&self) -> Option<i64>

Returns the integer value if this is Object::Integer.

Source

pub fn as_f64(&self) -> Option<f64>

Returns the floating-point value if this is Object::Real or Object::Integer.

Source

pub fn as_string(&self) -> Option<&PdfString>

Returns a reference to the PdfString if this is Object::String.

Source

pub fn as_name(&self) -> Option<&Name>

Returns a reference to the Name if this is Object::Name.

Source

pub fn as_array(&self) -> Option<&[Object]>

Returns a reference to the array if this is Object::Array.

Source

pub fn as_dict(&self) -> Option<&HashMap<Name, Object>>

Returns a reference to the dictionary if this is Object::Dictionary.

Source

pub fn as_stream_dict(&self) -> Option<&HashMap<Name, Object>>

Returns a reference to the stream dictionary if this is Object::Stream.

Source

pub fn as_reference(&self) -> Option<ObjectId>

Returns the ObjectId if this is Object::Reference.

Source

pub fn as_dict_mut(&mut self) -> Option<&mut HashMap<Name, Object>>

Returns a mutable reference to the dictionary if this is Object::Dictionary.

Source

pub fn as_array_mut(&mut self) -> Option<&mut Vec<Object>>

Returns a mutable reference to the array if this is Object::Array.

Source

pub fn is_null(&self) -> bool

Returns true if this is Object::Null.

Source

pub fn is_reference(&self) -> bool

Returns true if this is Object::Reference.

Trait Implementations§

Source§

impl Clone for Object

Source§

fn clone(&self) -> Object

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 Object

Source§

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

Formats the value using the given formatter. 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more