Struct Dict 

pub struct Dict<'a>(/* private fields */);

A dictionary, which is a key-value map, keys being names, and values being any PDF object or objetc reference.

Implementations

impl<'a> Dict<'a>

pub fn empty() -> Self

Create a new empty dictionary.

pub fn data(&self) -> &'a [u8]

Get the raw bytes underlying to the dictionary.

pub fn len(&self) -> usize

Returns the number of entries in the dictionary.

pub fn is_empty(&self) -> bool

Return whether the dictionary is empty.

pub fn contains_key(&self, key: impl Deref<Target = [u8]>) -> bool

Checks whether the dictionary contains an entry with a specific key.

pub fn get<T>(&self, key: impl Deref<Target = [u8]>) -> Option<T>

where T: ObjectLike<'a>,

Returns the entry of a key as a specific object, or try to resolve it in case it’s an object reference.

pub fn get_ref(&self, key: impl Deref<Target = [u8]>) -> Option<ObjRef>

Get the object reference linked to a key.

pub fn keys(&self) -> impl Iterator<Item = Name<'a>>

Returns an iterator over all keys in the dictionary.

pub fn entries(&self) -> impl Iterator<Item = (Name<'a>, MaybeRef<Object<'a>>)>

An iterator over all entries in the dictionary, sorted by key.

pub fn obj_id(&self) -> Option<ObjectIdentifier>

Return the object identifier of the dict, if it’s an indirect object.

pub fn get_raw<T>(&self, key: impl Deref<Target = [u8]>) -> Option<MaybeRef<T>>

where T: Readable<'a>,

Return the raw entry for a specific key.

Trait Implementations

impl<'a> Clone for Dict<'a>

fn clone(&self) -> Dict<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dict<'_>

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

Formats the value using the given formatter.

impl Default for Dict<'_>

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Dict<'_>

fn eq(&self, other: &Self) -> 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<'a> TryFrom<Object<'a>> for Dict<'a>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Object<'a>) -> Result<Self, Self::Error>

Performs the conversion.