Struct CoMap 

pub struct CoMap<K, V>(/* private fields */)
where
    K: Hash + Ord + Clone + Send + Sync + 'static,
    V: Clone + Send + Sync + 'static;

Implementations

impl<K, V> CoMap<K, V>

where K: Hash + Ord + Clone + Serialize + DeserializeOwned + Send + Sync + 'static, V: Clone + Serialize + DeserializeOwned + Send + Sync + 'static,

pub async fn from_iter<S>( storage: &S, iter: impl IntoIterator<Item = (K, V)>, ) -> Result<Self, StorageError>

where S: AnyBlockStorage,

Create collection from iterator.

pub fn is_empty(&self) -> bool

Whether this collection is empty.

pub async fn get<S>( &self, storage: &S, key: &K, ) -> Result<Option<V>, StorageError>

where S: AnyBlockStorage,

pub async fn contains<S>( &self, storage: &S, key: &K, ) -> Result<bool, StorageError>

where S: AnyBlockStorage,

pub fn stream<S>( &self, storage: &S, ) -> impl Stream<Item = Result<(K, V), StorageError>> + '_

where S: AnyBlockStorage,

pub async fn insert<S>( &mut self, storage: &S, key: K, value: V, ) -> Result<(), StorageError>

where S: AnyBlockStorage,

pub async fn remove<S>( &mut self, storage: &S, key: K, ) -> Result<Option<V>, StorageError>

where S: AnyBlockStorage,

pub async fn update_or_insert<S, F>( &mut self, storage: &S, key: K, update: F, ) -> Result<(), StorageError>

where V: Default, F: FnOnce(&mut V) + Send, S: AnyBlockStorage,

Update (or insert default) value.

pub async fn try_update_or_insert_async<S, F, Fut>( &mut self, storage: &S, key: K, update: F, ) -> Result<(), StorageError>

where V: Default, F: FnOnce(V) -> Fut + Send, Fut: Future<Output = Result<V, StorageError>> + Send, S: AnyBlockStorage,

Update (or insert default) value.

pub async fn update<S, F>( &mut self, storage: &S, key: K, update: F, ) -> Result<(), StorageError>

where F: FnOnce(&mut V) + Send, S: AnyBlockStorage,

Update value ignore if key not exists.

pub async fn try_update_async<S, F, Fut>( &mut self, storage: &S, key: K, update: F, ) -> Result<(), StorageError>

where F: FnOnce(V) -> Fut + Send, Fut: Future<Output = Result<V, StorageError>> + Send, S: AnyBlockStorage,

Update (or insert default) value.

pub async fn open_mut<'m, S>( &'m mut self, storage: &S, ) -> Result<CoMapMutTransaction<'m, S, K, V>, StorageError>

where S: AnyBlockStorage,

pub async fn open<S>( &self, storage: &S, ) -> Result<CoMapTransaction<S, K, V>, StorageError>

where S: AnyBlockStorage,

pub async fn open_lazy<S>( &self, storage: &S, ) -> Result<LazyTransaction<S, Self>, StorageError>

where S: AnyBlockStorage,

pub async fn commit<S>( &mut self, transaction: CoMapTransaction<S, K, V>, ) -> Result<(), StorageError>

where S: AnyBlockStorage,

Commit transaction to this map.

pub async fn with_transaction<S, F, Fut>( &mut self, storage: &S, update: F, ) -> Result<(), StorageError>

where S: AnyBlockStorage, F: FnOnce(CoMapTransaction<S, K, V>) -> Fut + Send, Fut: Future<Output = Result<CoMapTransaction<S, K, V>, StorageError>> + Send,

Open transaction, apply update and store it.

Trait Implementations

impl<K, V> Clone for CoMap<K, V>

where K: Hash + Ord + Clone + Send + Sync + 'static + Clone, V: Clone + Send + Sync + 'static + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K, V> Debug for CoMap<K, V>

where K: Hash + Ord + Clone + Send + Sync + 'static + Debug, V: Clone + Send + Sync + 'static + Debug,

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

Formats the value using the given formatter.

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

where K: Hash + Ord + Clone + Send + Sync + 'static, V: Clone + Send + Sync + 'static,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K, V> Deserialize<'de> for CoMap<K, V>

where K: Hash + Ord + Clone + Send + Sync + 'static + Deserialize<'de>, V: Clone + Send + Sync + 'static + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K, V> From<&CoMap<K, V>> for Option<Cid>

where K: Hash + Ord + Clone + Send + Sync + 'static, V: Clone + Send + Sync + 'static,

fn from(value: &CoMap<K, V>) -> Self

Converts to this type from the input type.

impl<K, V> From<Option<Cid<64>>> for CoMap<K, V>

where K: Hash + Ord + Clone + Send + Sync + 'static, V: Clone + Send + Sync + 'static,

fn from(cid: Option<Cid>) -> Self

Converts to this type from the input type.

impl<K, V> Hash for CoMap<K, V>

where K: Hash + Ord + Clone + Send + Sync + 'static + Hash, V: Clone + Send + Sync + 'static + Hash,

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, V> Ord for CoMap<K, V>

where K: Hash + Ord + Clone + Send + Sync + 'static + Ord, V: Clone + Send + Sync + 'static + Ord,

fn cmp(&self, other: &CoMap<K, V>) -> 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> PartialEq for CoMap<K, V>

where K: Hash + Ord + Clone + Send + Sync + 'static + PartialEq, V: Clone + Send + Sync + 'static + PartialEq,

fn eq(&self, other: &CoMap<K, V>) -> 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> PartialOrd for CoMap<K, V>

where K: Hash + Ord + Clone + Send + Sync + 'static + PartialOrd, V: Clone + Send + Sync + 'static + PartialOrd,

fn partial_cmp(&self, other: &CoMap<K, V>) -> 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, V> Serialize for CoMap<K, V>

where K: Hash + Ord + Clone + Send + Sync + 'static + Serialize, V: Clone + Send + Sync + 'static + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S, K, V> Streamable<S> for CoMap<K, V>

where S: AnyBlockStorage, K: Hash + Ord + Clone + Serialize + DeserializeOwned + Send + Sync + 'static, V: Clone + Serialize + DeserializeOwned + Send + Sync + 'static,

type Item = Result<(K, V), StorageError>

type Stream = Pin<Box<dyn Stream<Item = <CoMap<K, V> as Streamable<S>>::Item> + Send>>

fn stream(&self, storage: S) -> Self::Stream

impl<S, K, V> Transactionable<S> for CoMap<K, V>

where S: AnyBlockStorage, K: Hash + Ord + Clone + Serialize + DeserializeOwned + Send + Sync + 'static, V: Clone + Serialize + DeserializeOwned + Send + Sync + 'static,

type Transaction = CoMapTransaction<S, K, V>

fn open<'life0, 'life1, 'async_trait>( &'life0 self, storage: &'life1 S, ) -> Pin<Box<dyn Future<Output = Result<Self::Transaction, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

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

where K: Hash + Ord + Clone + Send + Sync + 'static + Eq, V: Clone + Send + Sync + 'static + Eq,

impl<K, V> StructuralPartialEq for CoMap<K, V>

where K: Hash + Ord + Clone + Send + Sync + 'static, V: Clone + Send + Sync + 'static,