Struct everscale_types::dict::Dict

pub struct Dict<C: CellFamily, K, V> { /* private fields */ }

Typed dictionary with fixed length keys.

Implementations

impl<C: CellFamily, K, V> Dict<C, K, V>

pub const fn new() -> Self

Creates an empty dictionary

pub const fn is_empty(&self) -> bool

Returns true if the dictionary contains no elements.

pub const fn root(&self) -> &Option<CellContainer<C>>

Returns the underlying root cell of the dictionary.

impl<C, K, V> Dict<C, K, V>where for<'c> C: CellFamily + 'c, K: DictKey,

pub fn load_from_root_ext( slice: &mut CellSlice<'_, C>, finalizer: &mut dyn Finalizer<C> ) -> Option<Self>

Loads a non-empty dictionary from a root cell.

impl<C, K, V> Dict<C, K, V>where for<'c> C: DefaultFinalizer + 'c, K: Store<C> + DictKey,

pub fn contains_key<Q>(&self, key: Q) -> Result<bool, Error>where Q: Borrow<K>,

Returns true if the dictionary contains a value for the specified key.

impl<C, K, V> Dict<C, K, V>where for<'c> C: DefaultFinalizer + 'c, K: Store<C> + DictKey,

pub fn get<'a: 'b, 'b, Q>(&'a self, key: Q) -> Result<Option<V>, Error>where Q: Borrow<K> + 'b, V: Load<'a, C>,

Returns the value corresponding to the key.

Key is serialized using the default finalizer.

pub fn get_raw<'a: 'b, 'b, Q>( &'a self, key: Q ) -> Result<Option<CellSlice<'a, C>>, Error>where Q: Borrow<K> + 'b,

Returns the raw value corresponding to the key.

Key is serialized using the default finalizer.

impl<C, K, V> Dict<C, K, V>where for<'c> C: DefaultFinalizer + 'c, K: Store<C> + DictKey, V: Store<C>,

pub fn set<Q, T>(&mut self, key: Q, value: T) -> Result<(), Error>where Q: Borrow<K>, T: Borrow<V>,

Sets the value associated with the key in the dictionary.

Use set_ext if you need to use a custom finalizer.

pub fn replace<Q, T>(&mut self, key: Q, value: T) -> Result<(), Error>where Q: Borrow<K>, T: Borrow<V>,

Sets the value associated with the key in the dictionary only if the key was already present in it.

Use replace_ext if you need to use a custom finalizer.

pub fn add<Q, T>(&mut self, key: Q, value: T) -> Result<(), Error>where Q: Borrow<K>, T: Borrow<V>,

Sets the value associated with key in dictionary, but only if it is not already present.

Use add_ext if you need to use a custom finalizer.

impl<C: CellFamily, K, V> Dict<C, K, V>where K: Store<C> + DictKey,

pub fn iter<'a>(&'a self) -> Iter<'_, C, K, V> where V: Load<'a, C>,

Gets an iterator over the entries of the dictionary, sorted by key. The iterator element type is Result<(K, V)>.

If the dictionary is invalid, finishes after the first invalid element, returning an error.

Performance

In the current implementation, iterating over dictionary builds a key for each element. Use values or raw_values if you don’t need keys from an iterator.

pub fn keys(&self) -> Keys<'_, C, K>

Gets an iterator over the keys of the dictionary, in sorted order. The iterator element type is Result<K>.

If the dictionary is invalid, finishes after the first invalid element, returning an error.

Performance

In the current implementation, iterating over dictionary builds a key for each element. Use values if you don’t need keys from an iterator.

impl<C, K, V> Dict<C, K, V>where for<'c> C: DefaultFinalizer + 'c, K: DictKey,

pub fn values<'a>(&'a self) -> Values<'a, C, V> where V: Load<'a, C>,

Gets an iterator over the values of the dictionary, in order by key. The iterator element type is Result<V>.

If the dictionary is invalid, finishes after the first invalid element, returning an error.

impl<C, K, V> Dict<C, K, V>where for<'c> C: CellFamily + 'c, K: Store<C> + DictKey,

pub fn get_ext<'a: 'b, 'b, Q>( &'a self, key: Q, finalizer: &mut dyn Finalizer<C> ) -> Result<Option<V>, Error>where Q: Borrow<K> + 'b, V: Load<'a, C>,

Returns the value corresponding to the key.

Key is serialized using the provided finalizer.

pub fn get_raw_ext<'a: 'b, 'b, Q>( &'a self, key: Q, finalizer: &mut dyn Finalizer<C> ) -> Result<Option<CellSlice<'a, C>>, Error>where Q: Borrow<K> + 'b,

Returns the value corresponding to the key.

Key is serialized using the provided finalizer.

pub fn raw_iter(&self) -> RawIter<'_, C>

Gets an iterator over the raw entries of the dictionary, sorted by key. The iterator element type is Result<(CellBuilder<C>, CellSlice<C>)>.

If the dictionary is invalid, finishes after the first invalid element, returning an error.

Performance

In the current implementation, iterating over dictionary builds a key for each element. Use values or raw_values if you don’t need keys from an iterator.

pub fn raw_keys(&self) -> RawKeys<'_, C>

Gets an iterator over the raw keys of the dictionary, in sorted order. The iterator element type is Result<CellBuilder<C>>.

If the dictionary is invalid, finishes after the first invalid element, returning an error.

Performance

In the current implementation, iterating over dictionary builds a key for each element. Use values or raw_values if you don’t need keys from an iterator.

impl<C, K, V> Dict<C, K, V>where for<'c> C: CellFamily + 'c, K: DictKey,

pub fn raw_values(&self) -> RawValues<'_, C>

Gets an iterator over the raw values of the dictionary, in order by key. The iterator element type is Result<CellSlice<C>>.

If the dictionary is invalid, finishes after the first invalid element, returning an error.

impl<C, K, V> Dict<C, K, V>where for<'c> C: CellFamily + 'c, K: Store<C> + DictKey, V: Store<C>,

pub fn set_ext<Q, T>( &mut self, key: Q, value: T, finalizer: &mut dyn Finalizer<C> ) -> Result<(), Error>where Q: Borrow<K>, T: Borrow<V>,

Sets the value associated with the key in the dictionary.

pub fn replace_ext<Q, T>( &mut self, key: Q, value: T, finalizer: &mut dyn Finalizer<C> ) -> Result<(), Error>where Q: Borrow<K>, T: Borrow<V>,

Sets the value associated with the key in the dictionary only if the key was already present in it.

pub fn add_ext<Q, T>( &mut self, key: Q, value: T, finalizer: &mut dyn Finalizer<C> ) -> Result<(), Error>where Q: Borrow<K>, T: Borrow<V>,

Sets the value associated with key in dictionary, but only if it is not already present.

Trait Implementations

impl<C: CellFamily, K, V> Clone for Dict<C, K, V>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: CellFamily, K, V> Debug for Dict<C, K, V>

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

Formats the value using the given formatter.

impl<C: CellFamily, K, V> Default for Dict<C, K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<C: CellFamily, K, V> From<Option<<C as CellFamily>::Container>> for Dict<C, K, V>

fn from(dict: Option<CellContainer<C>>) -> Self

Converts to this type from the input type.

impl<'a, C: CellFamily, K, V> Load<'a, C> for Dict<C, K, V>

fn load_from(slice: &mut CellSlice<'a, C>) -> Option<Self>

Tries to load itself from a cell slice.

impl<C: CellFamily, K, V> PartialEq<Dict<C, K, V>> for Dict<C, K, V>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C: CellFamily, K, V> Store<C> for Dict<C, K, V>

fn store_into( &self, builder: &mut CellBuilder<C>, finalizer: &mut dyn Finalizer<C> ) -> bool

Tries to store itself into the cell builder.

impl<C: CellFamily, K, V> Eq for Dict<C, K, V>