Struct Map 

pub struct Map<K, V: Storable<D>, D: DB = DefaultDB, A: Storable<D> + Annotation<V> = SizeAnn> { /* private fields */ }

A persistently stored map, guaranteeing O(1) clones and log-time modifications.

Implementations

impl<K: Serializable + Deserializable, V: Storable<D>, D: DB, A: Storable<D> + Annotation<V>> Map<K, V, D, A>

pub fn new() -> Self

Returns an empty map.

pub fn insert(&self, key: K, value: V) -> Self

Insert a key-value pair into the map. Must be O(log(|self|)).

pub fn remove(&self, key: &K) -> Self

Remove a key from the map. Must be O(log(|self|))

pub fn into_inner_for_drop(self) -> impl Iterator<Item = V>

Consume internal pointers, returning only the leaves left dangling by this. Used for custom Drop implementations.

pub fn iter( &self, ) -> impl Iterator<Item = (K, Sp<V, D>)> + use<'_, K, V, D, A> + '_

Iterate over the key-value pairs in the map in a deterministic, but unspecified order.

pub fn keys(&self) -> impl Iterator<Item = K> + use<'_, K, V, D, A> + '_

Iterator over the keys in the map in a deterministic, but unspecified order.

pub fn contains_key<Q>(&self, key: &Q) -> bool

where K: Borrow<Q>, Q: Ord + Serializable,

Check if the map contains a key. Must be O(log(|self|)).

pub fn get<Q>(&self, key: &Q) -> Option<&V>

where K: Borrow<Q>, Q: Serializable,

Retrieve the value stored at a key, if applicable. Must be O(log(|self|)).

pub fn lookup_sp<Q>(&self, key: &Q) -> Option<Sp<V, D>>

where Q: Serializable,

Lookup as Sp instead of raw V value.

pub fn is_empty(&self) -> bool

Check if the map is empty. Must be O(1).

pub fn size(&self) -> usize

Retrieve the number of key-value pairs in the map. Must be O(1).

pub fn ann(&self) -> A

Retrieve the annotation on the root of the trie

impl<V: Storable<D>, D: DB, A: Storable<D> + Annotation<V>> Map<BigEndianU64, V, D, A>

pub fn find_predecessor<'a>( &'a self, target_path: &BigEndianU64, ) -> Option<(Vec<u8>, &'a V)>

Find the nearest predecessor to a given target_path

pub fn prune(&self, target_path: &[u8]) -> (Self, Vec<Sp<V, D>>)

Prunes all paths which are lexicographically less than or equal to target_path. Returns the updated tree, and a vector of the removed leaves.

Panics

If any values in target_path are not u4 nibbles, i.e. larger than 15.

Trait Implementations

impl<K, V: Storable<D>, D: DB, A: Storable<D> + Annotation<V>> Clone for Map<K, V, D, A>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Deserializable + Debug, V: Storable<D> + Debug, D: DB, A: Storable<D> + Annotation<V>> Debug for Map<K, V, D, A>

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

Formats the value using the given formatter.

impl<K: Serializable + Deserializable, V: Storable<D>, D: DB, A: Storable<D> + Annotation<V>> Default for Map<K, V, D, A>

fn default() -> Self

Returns the “default value” for a type.

impl<K: Sync + Send + 'static + Deserializable, V: Storable<D>, D: DB, A: Storable<D> + Annotation<V>> Deserializable for Map<K, V, D, A>

fn deserialize(reader: &mut impl Read, recursion_depth: u32) -> Result<Self>

const LIMIT_RECURSION: bool = true

fn check_rec(depth: &mut u32) -> Result<(), Error>

impl<'de, K: Deserialize<'de> + Serializable + Deserializable, V: Deserialize<'de> + Storable<D1>, D1: DB, A: Storable<D1> + Annotation<V>> Deserialize<'de> for Map<K, V, D1, A>

fn deserialize<D: Deserializer<'de>>(de: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<K: Serializable + Deserializable, V: Storable<D>, D: DB, A: Storable<D> + Annotation<V>> Distribution<Map<K, V, D, A>> for Standard

where Standard: Distribution<V> + Distribution<K>,

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Map<K, V, D, A>

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl<K: Serializable + Deserializable + Storable<D>, V: Storable<D>, D: DB, A: Storable<D> + Annotation<(Sp<K, D>, Sp<V, D>)> + Annotation<V>> From<Map<K, V, D, A>> for HashMap<K, V, D, A>

fn from(value: Map<K, V, D, A>) -> Self

Converts to this type from the input type.

impl<K, V, D, A> FromIterator<(K, V)> for Map<K, V, D, A>

where K: Serializable + Deserializable, V: Storable<D>, D: DB, A: Storable<D> + Annotation<V>,

fn from_iter<T: IntoIterator<Item = (K, V)>>(iter: T) -> Self

Creates a value from an iterator.

impl<K, V: Storable<D>, D: DB, A: Storable<D> + Annotation<V>> Hash for Map<K, V, D, A>

fn hash<__H: Hasher>(&self, __state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<K: Clone + Serializable + Deserializable, V: Clone + Storable<D>, D: DB, A: Storable<D> + Annotation<V>> IntoIterator for Map<K, V, D, A>

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<(K, V)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V, D: DB, A> Ord for Map<K, V, D, A>

where V: Ord + Storable<D>, A: Ord + Storable<D> + Annotation<V>,

fn cmp(&self, __other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<K, V, D: DB, A> PartialEq for Map<K, V, D, A>

where V: PartialEq + Storable<D>, A: PartialEq + Storable<D> + Annotation<V>,

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<K, V, D: DB, A> PartialOrd for Map<K, V, D, A>

where V: PartialOrd + Storable<D>, A: PartialOrd + Storable<D> + Annotation<V>,

fn partial_cmp(&self, __other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<K: Sync + Send + 'static + Deserializable, V: Storable<D>, D: DB, A: Storable<D> + Annotation<V>> Serializable for Map<K, V, D, A>

fn serialize(&self, writer: &mut impl Write) -> Result<()>

fn serialized_size(&self) -> usize

impl<K: Serialize + Serializable + Deserializable, V: Storable<D> + Serialize, D: DB, A: Storable<D> + Annotation<V>> Serialize for Map<K, V, D, A>

fn serialize<S: Serializer>(&self, ser: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<K: Sync + Send + 'static + Deserializable, V: Storable<D>, D: DB, A: Storable<D> + Annotation<V>> Storable<D> for Map<K, V, D, A>

fn children(&self) -> Vec<ArenaKey<D::Hasher>>

Rather than in-lining the wrapped MPT it is a child such that we know the public Map has only a single child element (rather than up to 16)

fn to_binary_repr<W: Write>(&self, _writer: &mut W) -> Result<(), Error>

where Self: Sized,

Serializes self, omitting any children.

fn from_binary_repr<R: Read>( _reader: &mut R, child_hashes: &mut impl Iterator<Item = ArenaKey<D::Hasher>>, loader: &impl Loader<D>, ) -> Result<Self, Error>

where Self: Sized,

Instantiates self, given hashes of any children, and loader that loads children given their hash.

fn check_invariant(&self) -> Result<(), Error>

An invariant to check on deserialization. Should be invoked from within from_binary_repr.

fn as_child(&self) -> ArenaKey<<D as DB>::Hasher>

Represents self as a ArenaKey

impl<K: Tagged, V: Storable<D> + Tagged, D: DB, A: Storable<D> + Annotation<V> + Tagged> Tagged for Map<K, V, D, A>

fn tag() -> Cow<'static, str>

Retrieves the tag of Self. Returns a [Cow] as type arguments require allocation, but no allocation is preferred.

fn tag_unique_factor() -> String

A decomposition of this tag into primitive types (any type whose representation is not defined through other types), tuples (via (a,b)), and sum types (via [a,b]).

impl<K, V, D: DB, A> Eq for Map<K, V, D, A>

where V: Eq + Storable<D>, A: Eq + Storable<D> + Annotation<V>,