Struct CoList 

pub struct CoList<V>(/* private fields */)
where
    V: Clone + Send + Sync + 'static;

CoList stored values in a sequence.

Implementations

impl<V> CoList<V>

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

pub async fn from_iter<S>( storage: &S, iter: impl IntoIterator<Item = 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: &CoListIndex, ) -> Result<Option<V>, StorageError>

where S: AnyBlockStorage,

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

where S: AnyBlockStorage,

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

where S: AnyBlockStorage,

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

where S: AnyBlockStorage,

pub async fn vec<S>( &self, storage: &S, limit: Option<usize>, ) -> Result<Vec<V>, StorageError>

where S: AnyBlockStorage,

Convenience method to load all or limit entries into memory.

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

where S: AnyBlockStorage,

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

where S: AnyBlockStorage,

pub async fn push<S>( &mut self, storage: &S, value: V, ) -> Result<CoListIndex, StorageError>

where S: AnyBlockStorage,

pub async fn pop<S>( &mut self, storage: &S, ) -> Result<Option<(CoListIndex, V)>, StorageError>

where S: AnyBlockStorage,

Pop last element.

See: CoListTransaction::pop

pub async fn pop_front<S>( &mut self, storage: &S, ) -> Result<Option<(CoListIndex, V)>, StorageError>

where S: AnyBlockStorage,

Pop first element.

See: CoListTransaction::pop_front

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

where S: AnyBlockStorage,

pub async fn update_or_insert<S, F>( &mut self, storage: &S, key: CoListIndex, 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: CoListIndex, 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: CoListIndex, 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: CoListIndex, 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<S>( &self, storage: &S, ) -> Result<CoListTransaction<S, 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: CoListTransaction<S, V>, ) -> Result<(), StorageError>

where S: AnyBlockStorage,

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

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

Open transaction, apply update and store it.

Trait Implementations

impl<V> Clone for CoList<V>

where V: Clone + Send + Sync + 'static + Clone,

fn clone(&self) -> CoList<V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V> Debug for CoList<V>

where V: Clone + Send + Sync + 'static + Debug,

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

Formats the value using the given formatter.

impl<V> Default for CoList<V>

where V: Clone + Send + Sync + 'static,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, V> Deserialize<'de> for CoList<V>

where 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<V> From<&CoList<V>> for Option<Cid>

where V: Clone + Send + Sync + 'static,

fn from(value: &CoList<V>) -> Self

Converts to this type from the input type.

impl<V> From<Option<Cid<64>>> for CoList<V>

where V: Clone + Send + Sync + 'static,

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

Converts to this type from the input type.

impl<V> Hash for CoList<V>

where 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<V> Ord for CoList<V>

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

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

where V: Clone + Send + Sync + 'static + PartialEq,

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

where V: Clone + Send + Sync + 'static + PartialOrd,

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

where 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, V> Streamable<S> for CoList<V>

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

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

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

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

impl<S, V> Transactionable<S> for CoList<V>

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

type Transaction = CoListTransaction<S, 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<V> Eq for CoList<V>

where V: Clone + Send + Sync + 'static + Eq,

impl<V> StructuralPartialEq for CoList<V>

where V: Clone + Send + Sync + 'static,