Struct Batch 

pub struct Batch<'a, K, V, D>
where
    K: Array,
    V: CodecShared + Clone,
    D: Gettable<Key = K, Value = V, Error = Error> + Sync,
{ /* private fields */ }

A batch of changes which may be written to an underlying store with Batchable::write_batch. Writes and deletes to a batch are not applied to the store until the batch is written but will be reflected in reads from the batch.

Implementations

impl<'a, K, V, D> Batch<'a, K, V, D>

where K: Array, V: CodecShared + Clone, D: Gettable<Key = K, Value = V, Error = Error> + Sync,

pub const fn new(db: &'a D) -> Self

Returns a new batch of changes that may be written to the store.

pub async fn delete_unchecked(&mut self, key: K) -> Result<(), Error>

Deletes key from the batch without checking if it is present in the batch or store.

Trait Implementations

impl<'a, K, V, D> Deletable for Batch<'a, K, V, D>

where K: Array, V: CodecShared + Clone, D: Gettable<Key = K, Value = V, Error = Error> + Sync,

async fn delete(&mut self, key: K) -> Result<bool, Error>

Deletes key from the batch. Returns true if the key was in the batch or store, false otherwise.

impl<'a, K, V, D> Gettable for Batch<'a, K, V, D>

where K: Array, V: CodecShared + Clone, D: Gettable<Key = K, Value = V, Error = Error> + Sync,

async fn get(&self, key: &K) -> Result<Option<V>, Error>

Returns the value of key in the batch, or the value in the store if it is not present in the batch.

type Key = K

type Value = V

type Error = Error

impl<'a, K, V, D> IntoIterator for Batch<'a, K, V, D>

where K: Array, V: CodecShared + Clone, D: Gettable<Key = K, Value = V, Error = Error> + Sync,

type Item = (K, Option<V>)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, Option<V>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, K, V, D> Updatable for Batch<'a, K, V, D>

where K: Array, V: CodecShared + Clone, D: Gettable<Key = K, Value = V, Error = Error> + Sync,

async fn update(&mut self, key: K, value: V) -> Result<(), Error>

Updates the value of key to value in the batch.

fn create<'a>( &'a mut self, key: Self::Key, value: Self::Value, ) -> impl Future<Output = Result<bool, Self::Error>> + Send + use<'a, Self>

where Self: Send,

Creates a new key-value pair in the db. Returns true if the key was created, false if it already existed. The key is not modified if it already existed.

fn upsert<'a, F>( &'a mut self, key: Self::Key, update: F, ) -> impl Future<Output = Result<(), Self::Error>> + Send + use<'a, Self, F>

where Self: Send, Self::Value: Default, F: FnOnce(&mut Self::Value) + Send + 'a,

Updates the value associated with the given key in the store, inserting a default value if the key does not already exist.