Struct Node

Source
pub struct Node<K, V, H = Hasher>
where H: Hasher + CondSync, K: CondSync, V: CondSync,
{ /* private fields */ }
Expand description

Represents a node in the HAMT tree structure.

§Examples

use std::sync::Arc;
use wnfs_hamt::Node;
use wnfs_common::MemoryBlockStore;

let store = &MemoryBlockStore::new();
let node = Arc::new(Node::<String, usize>::default());

assert!(node.is_empty());

Implementations§

Source§

impl<K, V, H> Node<K, V, H>
where H: Hasher + CondSync, K: CondSync, V: CondSync,

Source

pub async fn set( self: &mut Arc<Self>, key: K, value: V, store: &impl BlockStore, ) -> Result<()>

Sets a new value at the given key.

§Examples
use std::sync::Arc;
use wnfs_hamt::Node;
use wnfs_common::MemoryBlockStore;

#[async_std::main]
async fn main() {
    let store = &MemoryBlockStore::new();
    let mut node = Arc::new(Node::<String, usize>::default());

    node.set("key".into(), 42, store).await.unwrap();
    assert_eq!(node.get(&String::from("key"), store).await.unwrap(), Some(&42));
}
Source

pub async fn get<'a>( &'a self, key: &K, store: &impl BlockStore, ) -> Result<Option<&'a V>>

Gets the value at the given key.

§Examples
use std::sync::Arc;
use wnfs_hamt::Node;
use wnfs_common::MemoryBlockStore;

#[async_std::main]
async fn main() {
    let store = &MemoryBlockStore::new();
    let mut node = Arc::new(Node::<String, usize>::default());

    node.set("key".into(), 42, store).await.unwrap();
    assert_eq!(node.get(&String::from("key"), store).await.unwrap(), Some(&42));
}
Source

pub async fn get_mut<'a>( self: &'a mut Arc<Self>, key: &K, store: &'a impl BlockStore, ) -> Result<Option<&'a mut V>>

Obtain a mutable reference to a given key.

Will copy parts of the tree to prepare for changes, if necessary.

§Examples
use std::sync::Arc;
use wnfs_hamt::Node;
use wnfs_common::MemoryBlockStore;

#[async_std::main]
async fn main() {
    let store = &mut MemoryBlockStore::new();
    let mut node = Arc::new(Node::<String, usize>::default());
    node.set("key".into(), 40, store).await.unwrap();

    let value = node.get_mut(&String::from("key"), store).await.unwrap().unwrap();
    *value += 2;

    assert_eq!(node.get(&String::from("key"), store).await.unwrap(), Some(&42));
}
Source

pub async fn remove( self: &mut Arc<Self>, key: &K, store: &impl BlockStore, ) -> Result<Option<Pair<K, V>>>

Removes the value at the given key.

§Examples
use std::sync::Arc;
use wnfs_hamt::{Node, Pair};
use wnfs_common::MemoryBlockStore;

#[async_std::main]
async fn main() {
    let store = &MemoryBlockStore::new();
    let mut node = Arc::new(Node::<String, usize>::default());

    node.set("key".into(), 42, store).await.unwrap();
    assert_eq!(node.get(&String::from("key"), store).await.unwrap(), Some(&42));

    let value = node.remove(&String::from("key"), store).await.unwrap();
    assert_eq!(value, Some(Pair::new("key".into(), 42)));
    assert_eq!(node.get(&String::from("key"), store).await.unwrap(), None);
}
Source

pub async fn get_by_hash<'a>( &'a self, hash: &HashOutput, store: &impl BlockStore, ) -> Result<Option<&'a V>>

Gets the value at the key matching the provided hash.

§Examples
use std::sync::Arc;
use wnfs_hamt::{Node, Hasher};
use wnfs_common::MemoryBlockStore;

#[async_std::main]
async fn main() {
    let store = &MemoryBlockStore::new();
    let mut node = Arc::new(Node::<String, usize>::default());

    node.set("key".into(), 42, store).await.unwrap();

    let key_hash = &blake3::Hasher::hash(&String::from("key"));
    assert_eq!(node.get_by_hash(key_hash, store).await.unwrap(), Some(&42));
}
Source

pub async fn remove_by_hash( self: &mut Arc<Self>, hash: &HashOutput, store: &impl BlockStore, ) -> Result<Option<Pair<K, V>>>

Removes the value at the key matching the provided hash.

§Examples
use std::sync::Arc;
use wnfs_hamt::{Node, Hasher, Pair};
use wnfs_common::MemoryBlockStore;

#[async_std::main]
async fn main() {
    let store = &MemoryBlockStore::new();
    let mut node = Arc::new(Node::<String, usize>::default());

    node.set("key".into(), 42, store).await.unwrap();
    assert_eq!(node.get(&String::from("key"), store).await.unwrap(), Some(&42));

    let key_hash = &blake3::Hasher::hash(&String::from("key"));
    let value = node.remove_by_hash(key_hash, store).await.unwrap();

    assert_eq!(value, Some(Pair::new("key".into(), 42)));
    assert_eq!(node.get(&String::from("key"), store).await.unwrap(), None);
}
Source

pub fn is_empty(&self) -> bool

Checks if the node is empty.

§Examples
use std::sync::Arc;
use wnfs_hamt::Node;
use wnfs_common::MemoryBlockStore;

#[async_std::main]
async fn main() {
    let store = &MemoryBlockStore::new();

    let mut node = Arc::new(Node::<String, usize>::default());
    assert!(node.is_empty());

    node.set("key".into(), 42, store).await.unwrap();
    assert!(!node.is_empty());
}
Source

pub fn set_value<'a>( self: &'a mut Arc<Self>, hashnibbles: &'a mut HashNibbles<'_>, key: K, value: V, store: &'a impl BlockStore, ) -> BoxFuture<'a, Result<()>>

Source

pub fn get_value<'a, 'life0, 'life1, 'async_recursion>( &'a self, hashnibbles: &'life0 mut HashNibbles<'_>, store: &'life1 impl BlockStore, ) -> Pin<Box<dyn Future<Output = Result<Option<&'a Pair<K, V>>>> + Send + 'async_recursion>>
where K: Storable + AsRef<[u8]>, V: Storable, K::Serializable: Serialize + DeserializeOwned, V::Serializable: Serialize + DeserializeOwned, 'life0: 'async_recursion, 'life1: 'async_recursion, 'a: 'async_recursion,

Source

pub fn get_value_mut<'a, 'life0, 'async_recursion>( self: &'a mut Arc<Self>, hashnibbles: &'life0 mut HashNibbles<'_>, store: &'a impl BlockStore, ) -> Pin<Box<dyn Future<Output = Result<Option<&'a mut Pair<K, V>>>> + Send + 'async_recursion>>
where K: Storable + AsRef<[u8]> + Clone, V: Storable + Clone, K::Serializable: Serialize + DeserializeOwned, V::Serializable: Serialize + DeserializeOwned, 'life0: 'async_recursion, 'a: 'async_recursion,

Source

pub fn remove_value<'a>( self: &'a mut Arc<Self>, hashnibbles: &'a mut HashNibbles<'_>, store: &'a impl BlockStore, ) -> BoxFuture<'a, Result<Option<Pair<K, V>>>>

Source

pub fn flat_map<'life0, 'life1, 'life_self, 'async_recursion, F, T>( &'life_self self, f: &'life0 F, store: &'life1 impl BlockStore, ) -> Pin<Box<dyn Future<Output = Result<Vec<T>>> + Send + 'async_recursion>>
where F: Fn(&Pair<K, V>) -> Result<T> + CondSync + 'async_recursion, K: Storable + AsRef<[u8]>, V: Storable, K::Serializable: Serialize + DeserializeOwned, V::Serializable: Serialize + DeserializeOwned, T: CondSend + 'async_recursion, 'life0: 'async_recursion, 'life1: 'async_recursion, 'life_self: 'async_recursion,

Visits all the leaf nodes in the trie and calls the given function on each of them.

§Examples
use std::sync::Arc;
use wnfs_hamt::{Node, Pair, Hasher};
use wnfs_common::{utils, MemoryBlockStore};

#[async_std::main]
async fn main() {
    let store = &MemoryBlockStore::new();
    let mut node = Arc::new(Node::<[u8; 4], String>::default());
    for i in 0..99_u32 {
        node
            .set(i.to_le_bytes(), i.to_string(), store)
            .await
            .unwrap();
    }

    let keys = node
        .flat_map(&|Pair { key, .. }| Ok(*key), store)
        .await
        .unwrap();

    assert_eq!(keys.len(), 99);
}
Source

pub fn get_node_at<'a, 'life0, 'life1, 'async_recursion>( &'a self, hashprefix: &'life0 HashPrefix, store: &'life1 impl BlockStore, ) -> Pin<Box<dyn Future<Output = Result<Option<Either<&'a Pair<K, V>, &'a Arc<Self>>>>> + Send + 'async_recursion>>
where K: Storable + AsRef<[u8]>, V: Storable, K::Serializable: Serialize + DeserializeOwned, V::Serializable: Serialize + DeserializeOwned, 'life0: 'async_recursion, 'life1: 'async_recursion, 'a: 'async_recursion,

Given a hashprefix representing the path to a node in the trie. This function will return the key-value pair or the intermediate node that the hashprefix points to.

§Examples
use std::sync::Arc;
use wnfs_hamt::{Node, HashPrefix, Hasher};
use wnfs_common::{MemoryBlockStore, utils};

#[async_std::main]
async fn main() {
    let store = &MemoryBlockStore::new();

    let mut node = Arc::new(Node::<[u8; 4], String>::default());
    for i in 0..100_u32 {
        node
            .set(i.to_le_bytes(), i.to_string(), store)
            .await
            .unwrap();
    }

    let hashprefix = HashPrefix::with_length(utils::to_hash_output(&[0x8C]), 2);
    let result = node.get_node_at(&hashprefix, store).await.unwrap();

    println!("Result: {:#?}", result);
}
Source

pub async fn to_hashmap<B: BlockStore>( &self, store: &B, ) -> Result<HashMap<K, V>>

Generates a hashmap from the node.

§Examples
use std::sync::Arc;
use wnfs_hamt::{Node, Hasher};
use wnfs_common::MemoryBlockStore;

#[async_std::main]
async fn main() {
    let store = &MemoryBlockStore::new();

    let mut node = Arc::new(Node::<[u8; 4], String>::default());
    for i in 0..100_u32 {
        node
            .set(i.to_le_bytes(), i.to_string(), store)
            .await
            .unwrap();
    }

    let map = node.to_hashmap(store).await.unwrap();

    assert_eq!(map.len(), 100);
}
Source

pub fn count_values(self: &Arc<Self>) -> Result<usize>

Returns the count of the values in all the values pointer of a node.

Trait Implementations§

Source§

impl<K: Clone + CondSync, V: CondSync + Clone, H: Hasher + CondSync> Clone for Node<K, V, H>

Source§

fn clone(&self) -> Self

Returns a duplicate 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, H> Debug for Node<K, V, H>
where K: Debug + CondSync, V: Debug + CondSync, H: Hasher + CondSync,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<K: CondSync, V: CondSync, H: Hasher + CondSync> Default for Node<K, V, H>

Source§

fn default() -> Self

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

impl<K, V, H> PartialEq for Node<K, V, H>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<K, V, H> Storable for Node<K, V, H>

Source§

type Serializable = NodeSerializable<<K as Storable>::Serializable, <V as Storable>::Serializable>

The at-rest representation of this storable type.
Source§

async fn to_serializable( &self, store: &impl BlockStore, ) -> Result<Self::Serializable>

Turn the current type into the at-rest representation of this type.
Source§

async fn from_serializable( cid: Option<&Cid>, serializable: Self::Serializable, ) -> Result<Self>

Take an at-rest representation of this type and turn it into the in-memory representation. You can use the cid parameter to populate a cache.
Source§

fn persisted_as(&self) -> Option<&OnceCell<Cid>>

Return a serialization cache, if it exists. By default, this always returns None.
Source§

fn store( &self, store: &impl BlockStore, ) -> impl Future<Output = Result<Cid<64>, Error>> + CondSend
where Self: CondSync,

Store this data type in a given BlockStore. Read more
Source§

fn load( cid: &Cid<64>, store: &impl BlockStore, ) -> impl Future<Output = Result<Self, Error>> + CondSend

Try to load a value of this type from a CID. Read more

Auto Trait Implementations§

§

impl<K, V, H = Hasher> !Freeze for Node<K, V, H>

§

impl<K, V, H> RefUnwindSafe for Node<K, V, H>

§

impl<K, V, H> Send for Node<K, V, H>

§

impl<K, V, H> Sync for Node<K, V, H>

§

impl<K, V, H> Unpin for Node<K, V, H>
where H: Unpin, K: Unpin, V: Unpin,

§

impl<K, V, H> UnwindSafe for Node<K, V, H>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> References<RawCodec> for T

Source§

fn references<R, E>(_c: RawCodec, _r: &mut R, _set: &mut E) -> Result<(), Error>
where R: Read, E: Extend<Cid<64>>,

Scrape the references from an impl Read. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<S> CondSend for S
where S: Send,

Source§

impl<S> CondSync for S
where S: Send + Sync,