Skip to main content

Dict

Struct Dict 

Source
pub struct Dict(/* private fields */);
Expand description

A dictionary. Keys are kept sorted, so iteration (and anything written from it) is deterministic. A repeated key keeps its last value.

Implementations§

Source§

impl Dict

Source

pub fn new() -> Dict

An empty dictionary.

Source

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

The value for key, if present. A null value counts as absent (ISO 32000-2 §7.3.7).

Source

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

Sets key to value, returning the previous value.

Source

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

Removes key, returning its value.

Source

pub fn contains_key(&self, key: &[u8]) -> bool

Whether key is present with a non-null value.

Source

pub fn len(&self) -> usize

The number of entries.

Source

pub fn is_empty(&self) -> bool

Whether there are no entries.

Source

pub fn iter(&self) -> impl Iterator<Item = (&Name, &Object)>

Entries in key order.

Source

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

The value for key if it is a name.

Source

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

The value for key if it is an integer.

Source

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

The value for key if it is a dictionary (or a stream’s dictionary).

Source

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

The value for key if it is an array.

Source

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

The value for key if it is an indirect reference.

Source

pub fn is_type(&self, ty: &[u8]) -> bool

Whether /Type is ty.

Trait Implementations§

Source§

impl Clone for Dict

Source§

fn clone(&self) -> Dict

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 Dict

Source§

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

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

impl Default for Dict

Source§

fn default() -> Dict

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

impl From<Dict> for Object

Source§

fn from(d: Dict) -> Object

Converts to this type from the input type.
Source§

impl FromIterator<(Name, Object)> for Dict

Source§

fn from_iter<I>(iter: I) -> Dict
where I: IntoIterator<Item = (Name, Object)>,

Creates a value from an iterator. Read more
Source§

impl PartialEq for Dict

Source§

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

Auto Trait Implementations§

§

impl Freeze for Dict

§

impl RefUnwindSafe for Dict

§

impl Send for Dict

§

impl Sync for Dict

§

impl Unpin for Dict

§

impl UnsafeUnpin for Dict

§

impl UnwindSafe for Dict

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> ErasedDestructor for T
where T: 'static,

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

Source§

type Output = T

Should always be Self
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<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.