Struct forest_actor::util::Multimap

pub struct Multimap<'a, BS>(_, _);

Multimap stores multiple values per key in a Hamt of Amts. The order of insertion of values for each key is retained.

Implementations

impl<'a, BS> Multimap<'a, BS> where
    BS: BlockStore, 

pub fn new(bs: &'a BS, outer_bitwidth: u32, inner_bitwidth: usize) -> Self

Initializes a new empty multimap. The outer_bitwidth is the width of the HAMT and the inner_bitwidth is the width of the AMTs inside of it.

pub fn from_root(
    bs: &'a BS,
    cid: &Cid,
    outer_bitwidth: u32,
    inner_bitwidth: usize
) -> Result<Self, Error>

Initializes a multimap from a root Cid

pub fn root(&mut self) -> Result<Cid, Error>

Retrieve root from the multimap.

pub fn add<V>(
    &mut self,
    key: BytesKey,
    value: V
) -> Result<(), Box<dyn StdError>> where
    V: Serialize + DeserializeOwned, 

Adds a value for a key.

pub fn get<V>(
    &self,
    key: &[u8]
) -> Result<Option<Amt<'a, V, BS>>, Box<dyn StdError>> where
    V: DeserializeOwned + Serialize, 

Gets the Array of value type V using the multimap store.

pub fn remove_all(&mut self, key: &[u8]) -> Result<(), Box<dyn StdError>>

Removes all values for a key.

pub fn for_each<F, V>(&self, key: &[u8], f: F) -> Result<(), Box<dyn StdError>> where
    V: Serialize + DeserializeOwned,
    F: FnMut(usize, &V) -> Result<(), Box<dyn StdError>>, 

Iterates through all values in the array at a given key.

pub fn for_all<F, V>(&self, f: F) -> Result<(), Box<dyn StdError>> where
    V: Serialize + DeserializeOwned,
    F: FnMut(&BytesKey, &Amt<'_, V, BS>) -> Result<(), Box<dyn StdError>>, 

Iterates through all arrays in the multimap