Struct everscale_types::dict::AugDict

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

Typed augmented dictionary with fixed length keys.

TLB scheme

ahm_edge#_ {n:#} {V:Type} {A:Type} {l:#} {m:#}
  label:(HmLabel ~l n) {n = (~m) + l}
  node:(HashmapAugNode m V A) = HashmapAug n V A;

ahmn_leaf#_ {V:Type} {A:Type} extra:A value:V = HashmapAugNode 0 V A;
ahmn_fork#_ {n:#} {V:Type} {A:Type} left:^(HashmapAug n V A)
  right:^(HashmapAug n V A) extra:A = HashmapAugNode (n + 1) V A;

ahme_empty$0 {n:#} {V:Type} {A:Type} extra:A = HashmapAugE n V A;
ahme_root$1 {n:#} {V:Type} {A:Type} root:^(HashmapAug n V A) extra:A = HashmapAugE n V A;

Implementations

impl<C: CellFamily, K, A: Default, V> AugDict<C, K, A, V>

pub fn new() -> Self

Creates an empty dictionary

impl<C: CellFamily, K, A, V> AugDict<C, K, A, V>

pub const fn is_empty(&self) -> bool

Returns true if the dictionary contains no elements.

pub const fn dict(&self) -> &Dict<C, K, (A, V)>

Returns the underlying dictionary.

pub const fn root_extra(&self) -> &A

Returns the root augmented value.

impl<C, K, A, V> AugDict<C, K, A, 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, A, V> AugDict<C, K, A, V>where for<'c> C: DefaultFinalizer + 'c, K: Store<C> + DictKey,

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

Returns the value corresponding to the key.

Key is serialized using the default finalizer.

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

pub fn iter<'a>(&'a self) -> AugIter<'_, C, K, A, 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, A, 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, A, V> AugDict<C, K, A, V>where for<'c> C: DefaultFinalizer + 'c, K: DictKey,

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

Gets an iterator over the augmented 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, A, V> AugDict<C, K, A, 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<(A, V)>, Error>where Q: Borrow<K> + 'b, A: Load<'a, C>, V: Load<'a, C>,

Returns the augmented 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, A, V> AugDict<C, K, A, 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.

Trait Implementations

impl<C: CellFamily, K, A: Clone, V> Clone for AugDict<C, K, A, 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, A: Debug, V> Debug for AugDict<C, K, A, V>

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

Formats the value using the given formatter.

impl<C: CellFamily, K, A: Default, V> Default for AugDict<C, K, A, V>

fn default() -> Self

Returns the “default value” for a type.

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

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

Tries to load itself from a cell slice.

impl<C: CellFamily, K, A: PartialEq, V> PartialEq<AugDict<C, K, A, V>> for AugDict<C, K, A, 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, A: Store<C>, V> Store<C> for AugDict<C, K, A, 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, A: Eq, V> Eq for AugDict<C, K, A, V>