Skip to main content

PdfObject

Enum PdfObject 

Source
pub enum PdfObject {
    Null,
    Bool(bool),
    Integer(i64),
    Real(f64),
    Name(PdfName),
    String(PdfString),
    HexString(PdfHexString),
    Array(PdfArray),
    Dict(PdfDict),
    Stream(PdfStream),
    Reference(PdfRef),
}
Expand description

A PDF object that can be any of the basic PDF types

Variants§

§

Null

Null object

§

Bool(bool)

Boolean value

§

Integer(i64)

Integer number

§

Real(f64)

Real number

§

Name(PdfName)

Name object (e.g., /Type)

§

String(PdfString)

Literal string

§

HexString(PdfHexString)

Hexadecimal string

§

Array(PdfArray)

Array of objects

§

Dict(PdfDict)

Dictionary

§

Stream(PdfStream)

Stream (dictionary + data)

§

Reference(PdfRef)

Indirect reference (e.g., 1 0 R)

Implementations§

Source§

impl PdfObject

Source

pub fn is_null(&self) -> bool

Returns true if this is a null object

Source

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

Returns the boolean value if this is a Bool, None otherwise

Source

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

Returns the integer value if this is an Integer, None otherwise

Source

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

Returns the real value if this is a Real or Integer, None otherwise

Source

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

Returns a reference to the Name if this is a Name, None otherwise

Source

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

Returns a reference to the String if this is a String, None otherwise

Source

pub fn as_array(&self) -> Option<&PdfArray>

Returns a reference to the Array if this is an Array, None otherwise

Source

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

Returns a mutable reference to the Array if this is an Array, None otherwise

Source

pub fn as_dict(&self) -> Option<&PdfDict>

Returns a reference to the Dict if this is a Dict, None otherwise

Source

pub fn as_dict_mut(&mut self) -> Option<&mut PdfDict>

Returns a mutable reference to the Dict if this is a Dict, None otherwise

Source

pub fn as_stream(&self) -> Option<&PdfStream>

Returns a reference to the Stream if this is a Stream, None otherwise

Source

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

Returns the Reference if this is a Reference, None otherwise

Source

pub fn type_name(&self) -> &'static str

Returns the type name of this object

Trait Implementations§

Source§

impl Clone for PdfObject

Source§

fn clone(&self) -> PdfObject

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 PdfObject

Source§

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

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

impl Display for PdfObject

Source§

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

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

impl From<PdfArray> for PdfObject

Source§

fn from(a: PdfArray) -> Self

Converts to this type from the input type.
Source§

impl From<PdfDict> for PdfObject

Source§

fn from(d: PdfDict) -> Self

Converts to this type from the input type.
Source§

impl From<PdfHexString> for PdfObject

Source§

fn from(s: PdfHexString) -> Self

Converts to this type from the input type.
Source§

impl From<PdfName> for PdfObject

Source§

fn from(n: PdfName) -> Self

Converts to this type from the input type.
Source§

impl From<PdfRef> for PdfObject

Source§

fn from(r: PdfRef) -> Self

Converts to this type from the input type.
Source§

impl From<PdfStream> for PdfObject

Source§

fn from(s: PdfStream) -> Self

Converts to this type from the input type.
Source§

impl From<PdfString> for PdfObject

Source§

fn from(s: PdfString) -> Self

Converts to this type from the input type.
Source§

impl From<bool> for PdfObject

Source§

fn from(b: bool) -> Self

Converts to this type from the input type.
Source§

impl From<f32> for PdfObject

Source§

fn from(r: f32) -> Self

Converts to this type from the input type.
Source§

impl From<f64> for PdfObject

Source§

fn from(r: f64) -> Self

Converts to this type from the input type.
Source§

impl From<i32> for PdfObject

Source§

fn from(i: i32) -> Self

Converts to this type from the input type.
Source§

impl From<i64> for PdfObject

Source§

fn from(i: i64) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for PdfObject

Source§

fn eq(&self, other: &PdfObject) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for PdfObject

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> 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<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

Source§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
Source§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

Source§

fn to_owned_table(&self) -> U

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.