Struct dusk_hamt::Hamt

source · [−]

pub struct Hamt<K, V, A>(_)
 where
    A: Annotation<KvPair<K, V>>;

Implementations

source

impl<K, V, A> Hamt<K, V, A> where
 K: Eq + Canon,
 V: Canon,
 A: Annotation<KvPair<K, V>> + Canon,

source

pub fn new() -> Self

Creates a new empty Hamt

source

pub fn insert(&mut self, key: K, val: V) -> Result<Option<V>, CanonError>

source

pub fn remove(&mut self, key: &K) -> Result<Option<V>, CanonError>

source

pub fn get<'a>(
&'a self,
key: &K
) -> Result<Option<impl Deref<Target = V> + 'a>, CanonError>

source

pub fn get_mut<'a>(
&'a mut self,
key: &K
) -> Result<Option<impl DerefMut<Target = V> + 'a>, CanonError>

Trait Implementations

source

impl<K: Canon, V: Canon, A: Canon> Canon for Hamt<K, V, A> where
A: Annotation<KvPair<K, V>>,

source

fn encode(&self, sink: &mut Sink<'_>)

Write the encoded value as bytes to a Sink

source

fn decode(source: &mut Source<'_>) -> Result<Self, CanonError>

Return the decoded value from bytes in a Source

source

fn encoded_len(&self) -> usize

Returns the number of bytes needed to encode this value

source

impl<K: Clone, V: Clone, A: Clone> Clone for Hamt<K, V, A> where
A: Annotation<KvPair<K, V>>,

source

fn clone(&self) -> Hamt<K, V, A>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<K, V, A> Compound<A> for Hamt<K, V, A> where
 A: Annotation<KvPair<K, V>>,
 K: Canon,
 V: Canon,
 A: Canon,

type Leaf = KvPair<K, V>

The leaf type of the Compound collection

source

fn child(&self, ofs: usize) -> Child<'_, Self, A>

Returns a reference to a possible child at specified offset

source

fn child_mut(&mut self, ofs: usize) -> ChildMut<'_, Self, A>

Returns a mutable reference to a possible child at specified offset

source

fn from_generic(generic: &GenericTree) -> Result<Self, CanonError>

Construct a specific compound tree from a generic tree

source

fn annotations(&self) -> AnnoIter<'_, Self, A> where
A: Annotation<Self::Leaf>,

Provides an iterator over all sub-annotations of the compound node

source

fn generic(&self) -> GenericTree where
A: Annotation<Self::Leaf>,
Self::Leaf: Canon,

Returns a generic version of this compound tree, erasing the specific annotation and leaf types, to provide a universal tree encoding. Read more

source

impl<K: Debug, V: Debug, A: Debug> Debug for Hamt<K, V, A> where
A: Annotation<KvPair<K, V>>,

source

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

Formats the value using the given formatter. Read more

source

impl<K, V, A> Default for Hamt<K, V, A> where
A: Annotation<KvPair<K, V>>,

source

fn default() -> Self

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

Auto Trait Implementations

impl<K, V, A> !RefUnwindSafe for Hamt<K, V, A>

impl<K, V, A> Send for Hamt<K, V, A> where
 A: Send + Sync,
 K: Send + Sync,
 V: Send + Sync,

impl<K, V, A> Sync for Hamt<K, V, A> where
 A: Send + Sync,
 K: Send + Sync,
 V: Send + Sync,

impl<K, V, A> Unpin for Hamt<K, V, A> where
 A: Unpin,
 K: Unpin,
 V: Unpin,

impl<K, V, A> !UnwindSafe for Hamt<K, V, A>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> EncodeToVec for T where
T: Canon,

source

pub fn encode_to_vec(&self) -> Vec<u8, Global>

Encode Self into a buffer

source

impl<'a, C, A> First<'a, A> for C where
C: Compound<A>,
A: Canon,

source

pub fn first(&'a self) -> Result<Option<Branch<'a, C, A>>, CanonError>

Construct a Branch pointing to the first element, if not empty

source

pub fn first_mut(
&'a mut self
) -> Result<Option<BranchMut<'a, C, A>>, CanonError> where
C: MutableLeaves + Clone,

Construct a BranchMut pointing to the first element, if not empty

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<'a, C, A, K> GetMaxKey<'a, A, K> for C where
 C: Compound<A> + Clone,
 A: Annotation<<C as Compound<A>>::Leaf> + Borrow<MaxKey<K>>,
 K: Ord + Clone + Debug,
 <C as Compound<A>>::Leaf: Keyed<K>,

source

pub fn max_key(&'a self) -> Result<Option<Branch<'a, C, A>>, CanonError>

Construct a Branch pointing to the element with the largest key

source

pub fn max_key_mut(
&'a mut self
) -> Result<Option<BranchMut<'a, C, A>>, CanonError> where
C: MutableLeaves,

Construct a BranchMut pointing to the element with the largest key

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub 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> Keyed<T> for T

source

pub fn key(&self) -> &T

Return a reference to the key of the leaf type

source

impl<'a, C, A> Nth<'a, A> for C where
C: Compound<A> + Clone,
A: Annotation<<C as Compound<A>>::Leaf> + Borrow<Cardinality>,

source

pub fn nth(&'a self, ofs: u64) -> Result<Option<Branch<'a, C, A>>, CanonError>

Construct a Branch pointing to the nth element, if any

source

pub fn nth_mut(
 &'a mut self,
 ofs: u64
) -> Result<Option<BranchMut<'a, C, A>>, CanonError> where
 C: MutableLeaves,

Construct a BranchMut pointing to the nth element, if any

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct dusk_hamt::Hamt

Implementations

impl<K, V, A> Hamt<K, V, A> where K: Eq + Canon, V: Canon, A: Annotation<KvPair<K, V>> + Canon,

pub fn new() -> Self

pub fn insert(&mut self, key: K, val: V) -> Result<Option<V>, CanonError>

pub fn remove(&mut self, key: &K) -> Result<Option<V>, CanonError>

pub fn get<'a>( &'a self, key: &K) -> Result<Option<impl Deref<Target = V> + 'a>, CanonError>

pub fn get_mut<'a>( &'a mut self, key: &K) -> Result<Option<impl DerefMut<Target = V> + 'a>, CanonError>

Trait Implementations

impl<K: Canon, V: Canon, A: Canon> Canon for Hamt<K, V, A> where A: Annotation<KvPair<K, V>>,

fn encode(&self, sink: &mut Sink<'_>)

fn decode(source: &mut Source<'_>) -> Result<Self, CanonError>

fn encoded_len(&self) -> usize

impl<K: Clone, V: Clone, A: Clone> Clone for Hamt<K, V, A> where A: Annotation<KvPair<K, V>>,

fn clone(&self) -> Hamt<K, V, A>

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

impl<K, V, A> Compound<A> for Hamt<K, V, A> where A: Annotation<KvPair<K, V>>, K: Canon, V: Canon, A: Canon,

type Leaf = KvPair<K, V>

fn child(&self, ofs: usize) -> Child<'_, Self, A>

fn child_mut(&mut self, ofs: usize) -> ChildMut<'_, Self, A>

fn from_generic(generic: &GenericTree) -> Result<Self, CanonError>

fn annotations(&self) -> AnnoIter<'_, Self, A> where A: Annotation<Self::Leaf>,

fn generic(&self) -> GenericTree where A: Annotation<Self::Leaf>, Self::Leaf: Canon,

impl<K: Debug, V: Debug, A: Debug> Debug for Hamt<K, V, A> where A: Annotation<KvPair<K, V>>,

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

impl<K, V, A> Default for Hamt<K, V, A> where A: Annotation<KvPair<K, V>>,

fn default() -> Self

Auto Trait Implementations

impl<K, V, A> !RefUnwindSafe for Hamt<K, V, A>

impl<K, V, A> Send for Hamt<K, V, A> where A: Send + Sync, K: Send + Sync, V: Send + Sync,

impl<K, V, A> Sync for Hamt<K, V, A> where A: Send + Sync, K: Send + Sync, V: Send + Sync,

impl<K, V, A> Unpin for Hamt<K, V, A> where A: Unpin, K: Unpin, V: Unpin,

impl<K, V, A> !UnwindSafe for Hamt<K, V, A>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> EncodeToVec for T where T: Canon,

pub fn encode_to_vec(&self) -> Vec<u8, Global>

impl<'a, C, A> First<'a, A> for C where C: Compound<A>, A: Canon,

pub fn first(&'a self) -> Result<Option<Branch<'a, C, A>>, CanonError>

pub fn first_mut( &'a mut self) -> Result<Option<BranchMut<'a, C, A>>, CanonError> where C: MutableLeaves + Clone,

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<'a, C, A, K> GetMaxKey<'a, A, K> for C where C: Compound<A> + Clone, A: Annotation<<C as Compound<A>>::Leaf> + Borrow<MaxKey<K>>, K: Ord + Clone + Debug, <C as Compound<A>>::Leaf: Keyed<K>,

pub fn max_key(&'a self) -> Result<Option<Branch<'a, C, A>>, CanonError>

pub fn max_key_mut( &'a mut self) -> Result<Option<BranchMut<'a, C, A>>, CanonError> where C: MutableLeaves,

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Keyed<T> for T

pub fn key(&self) -> &T

impl<'a, C, A> Nth<'a, A> for C where C: Compound<A> + Clone, A: Annotation<<C as Compound<A>>::Leaf> + Borrow<Cardinality>,

pub fn nth(&'a self, ofs: u64) -> Result<Option<Branch<'a, C, A>>, CanonError>

pub fn nth_mut( &'a mut self, ofs: u64) -> Result<Option<BranchMut<'a, C, A>>, CanonError> where C: MutableLeaves,

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<K, V, A> Hamt<K, V, A> where
K: Eq + Canon,
V: Canon,
A: Annotation<KvPair<K, V>> + Canon,

pub fn get<'a>(
&'a self,
key: &K
) -> Result<Option<impl Deref<Target = V> + 'a>, CanonError>

pub fn get_mut<'a>(
&'a mut self,
key: &K
) -> Result<Option<impl DerefMut<Target = V> + 'a>, CanonError>

impl<K: Canon, V: Canon, A: Canon> Canon for Hamt<K, V, A> where
A: Annotation<KvPair<K, V>>,

impl<K: Clone, V: Clone, A: Clone> Clone for Hamt<K, V, A> where
A: Annotation<KvPair<K, V>>,

impl<K, V, A> Compound<A> for Hamt<K, V, A> where
A: Annotation<KvPair<K, V>>,
K: Canon,
V: Canon,
A: Canon,

fn annotations(&self) -> AnnoIter<'_, Self, A> where
A: Annotation<Self::Leaf>,

fn generic(&self) -> GenericTree where
A: Annotation<Self::Leaf>,
Self::Leaf: Canon,

impl<K: Debug, V: Debug, A: Debug> Debug for Hamt<K, V, A> where
A: Annotation<KvPair<K, V>>,

impl<K, V, A> Default for Hamt<K, V, A> where
A: Annotation<KvPair<K, V>>,

impl<K, V, A> Send for Hamt<K, V, A> where
A: Send + Sync,
K: Send + Sync,
V: Send + Sync,

impl<K, V, A> Sync for Hamt<K, V, A> where
A: Send + Sync,
K: Send + Sync,
V: Send + Sync,

impl<K, V, A> Unpin for Hamt<K, V, A> where
A: Unpin,
K: Unpin,
V: Unpin,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> EncodeToVec for T where
T: Canon,

impl<'a, C, A> First<'a, A> for C where
C: Compound<A>,
A: Canon,

pub fn first_mut(
&'a mut self
) -> Result<Option<BranchMut<'a, C, A>>, CanonError> where
C: MutableLeaves + Clone,

impl<'a, C, A, K> GetMaxKey<'a, A, K> for C where
C: Compound<A> + Clone,
A: Annotation<<C as Compound<A>>::Leaf> + Borrow<MaxKey<K>>,
K: Ord + Clone + Debug,
<C as Compound<A>>::Leaf: Keyed<K>,

pub fn max_key_mut(
&'a mut self
) -> Result<Option<BranchMut<'a, C, A>>, CanonError> where
C: MutableLeaves,

impl<T, U> Into<U> for T where
U: From<T>,

impl<'a, C, A> Nth<'a, A> for C where
C: Compound<A> + Clone,
A: Annotation<<C as Compound<A>>::Leaf> + Borrow<Cardinality>,

pub fn nth_mut(
&'a mut self,
ofs: u64
) -> Result<Option<BranchMut<'a, C, A>>, CanonError> where
C: MutableLeaves,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,