Struct everscale_types::dict::Dict

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

Typed dictionary with fixed length keys.

Implementations

impl<K, V> Dict<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<Cell>

Returns the underlying root cell of the dictionary.

impl<K: DictKey, V> Dict<K, V>

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

Loads a non-empty dictionary from a root cell.

impl<K, V> Dict<K, V>where K: Store + 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<K, V> Dict<K, V>where K: Store + DictKey,

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

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>>, Error>where Q: Borrow<K> + 'b,

Returns the raw value corresponding to the key.

Key is serialized using the default finalizer.

pub fn remove<Q>(&mut self, key: Q) -> Result<Option<V>, Error>where Q: Borrow<K>, for<'a> V: Load<'a> + 'static,

Removes the value associated with key in dictionary. Returns an optional removed value.

Key is serialized using the default finalizer.

pub fn remove_raw<Q>(&mut self, key: Q) -> Result<Option<CellSliceParts>, Error>where Q: Borrow<K>,

Removes the value associated with key in dictionary. Returns an optional removed value as cell slice parts.

Key is serialized using the default finalizer.

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

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<K, V> Dict<K, V>where K: Store + DictKey,

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

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<'_, 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<K, V> Dict<K, V>where K: DictKey,

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

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<K, V> Dict<K, V>where K: Store + DictKey,

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

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 ) -> Result<Option<CellSlice<'a>>, Error>where Q: Borrow<K> + 'b,

Returns the value corresponding to the key.

Key is serialized using the provided finalizer.

pub fn remove_raw_ext<Q>( &mut self, key: Q, finalizer: &mut dyn Finalizer ) -> Result<Option<CellSliceParts>, Error>where Q: Borrow<K>,

Removes the value associated with key in dictionary. Returns an optional removed value as cell slice parts.

Key is serialized using the provided finalizer.

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

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

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<'_>

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

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<K, V> Dict<K, V>where K: DictKey,

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

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

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

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

pub fn set_ext<Q, T>( &mut self, key: Q, value: T, finalizer: &mut dyn Finalizer ) -> 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 ) -> 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 ) -> 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 BlockSignatureExt for Dict<u16, BlockSignature>

fn check_signatures( &self, list: &[ValidatorDescription], data: &[u8] ) -> Result<u64, Error>

Verifies signatures for the specified data and the provided list of nodes.

impl<K, V> Clone for Dict<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<K, V> Debug for Dict<K, V>

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

Formats the value using the given formatter.

impl<K, V> Default for Dict<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<K, V> From<Option<Cell>> for Dict<K, V>

fn from(dict: Option<Cell>) -> Self

Converts to this type from the input type.

impl<'a, K, V> Load<'a> for Dict<K, V>

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

Tries to load itself from a cell slice.

impl<K, V> PartialEq<Dict<K, V>> for Dict<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<K, V> Store for Dict<K, V>

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

Tries to store itself into the cell builder.

impl<K, V> Eq for Dict<K, V>