Struct PdfDict

Source

pub struct PdfDict(/* private fields */);

Expand description

A PDF dictionary: ordered list of (name, value) pairs.

Implementations§

Source §

impl PdfDict

Source

pub fn new() -> Self

Source

pub fn get(&self, key: &[u8]) -> Option<&PdfObj>

Look up a key by name (without leading /).

Source

pub fn get_name(&self, key: &[u8]) -> Option<&[u8]>

Get a name value for a key.

Source

pub fn get_int(&self, key: &[u8]) -> Option<i64>

Get an integer value for a key.

Source

pub fn get_f64(&self, key: &[u8]) -> Option<f64>

Get a numeric (int or real) value as f64.

Source

pub fn get_bool(&self, key: &[u8]) -> Option<bool>

Get a boolean value for a key.

Source

pub fn get_array(&self, key: &[u8]) -> Option<&[PdfObj]>

Get an array value for a key.

Source

pub fn get_dict(&self, key: &[u8]) -> Option<&PdfDict>

Get a dict value for a key.

Source

pub fn get_ref(&self, key: &[u8]) -> Option<(u32, u16)>

Get an indirect reference for a key.

Source

pub fn get_derefable(&self, key: &[u8]) -> Option<&PdfObj>

Get a reference or inline dict — returns the PdfObj for the caller to resolve.

Source

pub fn insert(&mut self, key: Vec<u8>, val: PdfObj)

Insert or replace a key-value pair.

Source

pub fn entries(&self) -> &[(Vec<u8>, PdfObj)]

Get all entries.

Source

pub fn into_entries(self) -> Vec<(Vec<u8>, PdfObj)>

Consume the dict and return owned entries.

Source

pub fn from_entries(entries: Vec<(Vec<u8>, PdfObj)>) -> Self

Create a dict from owned entries.

Source

pub fn len(&self) -> usize

Number of entries.

Source

pub fn is_empty(&self) -> bool

Whether the dict is empty.

Trait Implementations§

Source §

impl Clone for PdfDict

Source §

fn clone(&self) -> PdfDict

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for PdfDict

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for PdfDict

Source §

fn default() -> PdfDict

Returns the “default value” for a type. Read more

Source §

impl PartialEq for PdfDict

Source §

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Source §

impl StructuralPartialEq for PdfDict

Auto Trait Implementations§

§

impl UnwindSafe for PdfDict

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 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §