Struct Batch 

pub struct Batch {
    pub preconditions: Vec<Precondition>,
    pub writes: Vec<Write>,
}

One atomic, declarative write: preconditions, then puts and deletes in order (a later write to the same key wins). A batch with no writes only checks.

Fields

preconditions: Vec<Precondition>

Checked in order; the first failure aborts the batch.

writes: Vec<Write>

Applied in order if every precondition holds.

Implementations

impl Batch

pub fn new() -> Self

An empty batch.

pub fn require(self, precondition: Precondition) -> Self

Append a precondition.

pub fn put(self, key: Key, value: Value) -> Self

Append a put.

pub fn delete(self, key: Key) -> Self

Append a delete.

pub fn has_put(&self) -> bool

Whether the batch adds data (holds a put): what a full partition rejects with StoreError::Full.

pub fn validate(&self, caps: &StoreCapabilities) -> Result<(), StoreError>

Check the batch against the size limits and a store’s capabilities, before anything is read or written. Every backend calls this first in NamespaceStore::apply.

Errors

StoreError::Invalid for a key over MAX_KEY_BYTES, a value over MAX_VALUE_BYTES (510 KiB for timer payloads), more than MAX_BATCH_OPS operations or more than MAX_BATCH_BYTES in total; StoreError::Unsupported for a key outside caps.key_classes, or, without atomic_multi_key, more than one write or a key precondition on another key than the write.

Trait Implementations

impl Clone for Batch

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Batch

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

Formats the value using the given formatter.

impl Default for Batch

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Batch

impl PartialEq for Batch

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Batch