Enum lopdf::Object

pub enum Object {
    Null,
    Boolean(bool),
    Integer(i64),
    Real(f32),
    Name(Vec<u8>),
    String(Vec<u8>, StringFormat),
    Array(Vec<Object>),
    Dictionary(Dictionary),
    Stream(Stream),
    Reference(ObjectId),
}

Basic PDF object types defined in an enum.

Variants

Null

Boolean(bool)

Integer(i64)

Real(f32)

Name(Vec<u8>)

String(Vec<u8>, StringFormat)

Array(Vec<Object>)

Dictionary(Dictionary)

Stream(Stream)

Reference(ObjectId)

Implementations

impl Object

pub fn string_literal<S: Into<Vec<u8>>>(s: S) -> Self

pub fn is_null(&self) -> bool

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

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

pub fn as_f32(&self) -> Result<f32>

pub fn as_float(&self) -> Result<f32>

Get the object value as a float. Unlike as_f64() this will also cast an Integer to a Real.

pub fn as_name(&self) -> Result<&[u8]>

pub fn as_name_str(&self) -> Result<&str>

pub fn as_str(&self) -> Result<&[u8]>

pub fn as_str_mut(&mut self) -> Result<&mut Vec<u8>>

pub fn as_string(&self) -> Result<Cow<'_, str>>

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

pub fn as_array(&self) -> Result<&Vec<Object>>

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

pub fn as_dict(&self) -> Result<&Dictionary>

pub fn as_dict_mut(&mut self) -> Result<&mut Dictionary>

pub fn as_stream(&self) -> Result<&Stream>

pub fn as_stream_mut(&mut self) -> Result<&mut Stream>

pub fn type_name(&self) -> Result<&str>

impl Object

pub fn as_datetime(&self) -> Option<DateTime<Local>>

Trait Implementations

impl Clone for Object

fn clone(&self) -> Object

Returns a copy 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> From<&'a str> for Object

fn from(name: &'a str) -> Self

Converts to this type from the input type.

impl From<(u32, u16)> for Object

fn from(id: ObjectId) -> Self

Converts to this type from the input type.

impl From<DateTime<Local>> for Object

fn from(date: DateTime<Local>) -> Self

Converts to this type from the input type.

impl From<DateTime<Utc>> for Object

fn from(date: DateTime<Utc>) -> Self

Converts to this type from the input type.

impl From<Dictionary> for Object

fn from(dict: Dictionary) -> Self

Converts to this type from the input type.

impl From<OffsetDateTime> for Object

fn from(date: OffsetDateTime) -> Self

Converts to this type from the input type.

impl From<Stream> for Object

fn from(stream: Stream) -> Self

Converts to this type from the input type.

impl From<String> for Object

fn from(name: String) -> Self

Converts to this type from the input type.

impl From<Time> for Object

fn from(date: Time) -> Self

Converts to this type from the input type.

impl From<Vec<Object, Global>> for Object

fn from(array: Vec<Object>) -> 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(number: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Object

fn from(number: f64) -> Self

Converts to this type from the input type.

impl From<i16> for Object

fn from(number: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Object

fn from(number: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Object

fn from(number: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Object

fn from(number: i8) -> Self

Converts to this type from the input type.

impl From<u16> for Object

fn from(number: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Object

fn from(number: u32) -> Self

Converts to this type from the input type.

impl From<u8> for Object

fn from(number: u8) -> Self

Converts to this type from the input type.