Enum Object 

pub enum Object {
    Null,
    Boolean(bool),
    Integer(i64),
    Real(f64),
    String(Vec<u8>),
    Name(String),
    Array(Vec<Object>),
    Dict(Vec<(String, Object)>),
    Ref(u64),
    Stream {
        dict: Vec<(String, Object)>,
        data: Vec<u8>,
    },
}

PDF object types as specified in PDF 1.7 specification.

Variants

Null

Null object.

Boolean(bool)

Boolean object.

Integer(i64)

Integer object.

Real(f64)

Real (floating-point) object.

String(Vec<u8>)

String object (binary data, typically 8-bit or Unicode).

Name(String)

Name object.

Array(Vec<Object>)

Array object, containing other PDF objects.

Dict(Vec<(String, Object)>)

Dictionary object, key-value pairs.

Ref(u64)

Indirect reference object reference by object number.

Stream

Stream object, dictionary + data.

Fields

dict: Vec<(String, Object)>

data: Vec<u8>

Implementations

impl Object

pub fn name(s: impl Into<String>) -> Self

Creates a new Name object.

pub fn dict( entries: impl IntoIterator<Item = (impl Into<String>, impl Into<Object>)>, ) -> Self

Creates a new Dictionary object from key-value pairs.

pub fn array(items: impl IntoIterator<Item = impl Into<Object>>) -> Self

Creates a new Array object.

pub fn string(s: impl AsRef<[u8]>) -> Self

Creates a new String object from bytes.

pub fn string_utf16(s: &str) -> Self

Creates a new UTF-16BE encoded String object.

pub fn integer(n: i64) -> Self

Creates a new Integer object.

pub fn real(n: f64) -> Self

Creates a new Real object.

pub fn insert( &mut self, key: impl Into<String>, value: impl Into<Object>, ) -> Result<()>

Inserts a key-value pair into a dictionary object. Returns an error if self is not a Dict.

pub fn get(&self, key: &str) -> Option<&Object>

Gets a value from a dictionary object by key. Returns None if the object is not a Dict or key doesn’t exist.

pub fn push(&mut self, item: impl Into<Object>) -> Result<()>

Pushes an item to an array object. Returns an error if self is not an Array.

pub fn write<W: Write>(&self, writer: &mut W) -> Result<()>

Writes the object to a writer as PDF syntax.

Trait Implementations

impl Clone for Object

fn clone(&self) -> Object

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Object

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

Formats the value using the given formatter.

impl<'a, T: Into<Object> + Clone> From<&'a [T]> for Object

fn from(value: &'a [T]) -> Self

Converts to this type from the input type.

impl From<&str> for Object

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for Object

fn from(value: String) -> Self

Converts to this type from the input type.

impl<T: Into<Object>> From<Vec<T>> for Object

fn from(value: Vec<T>) -> Self

Converts to this type from the input type.

impl From<bool> for Object

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Object

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Object

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Object

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Object

fn from(value: i64) -> Self

Converts to this type from the input type.

impl PartialEq for Object

fn eq(&self, other: &Object) -> 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 StructuralPartialEq for Object