Struct linera_views::batch::Batch

pub struct Batch {
    pub operations: Vec<WriteOperation>,
}

A batch of write operations.

Fields

operations: Vec<WriteOperation>

The write operations.

Implementations

impl Batch

pub fn new() -> Self

Creates an empty batch.

pub fn size(&self) -> usize

The total size of the batch

pub fn is_empty(&self) -> bool

Whether the batch is empty or not

pub fn num_operations(&self) -> usize

Returns the number of operations in this Batch.

pub async fn build<F>(builder: F) -> Result<Self, ViewError>

where F: FnOnce(&mut Batch) -> BoxFuture<'_, Result<(), ViewError>> + Send + Sync,

Builds a batch from a builder function.

pub fn simplify(self) -> UnorderedBatch

Simplifies the batch by removing operations that are overwritten by others.

A key may appear multiple times in the batch, as an insert, a delete or matched by a delete prefix.

let mut batch = Batch::new();
batch.put_key_value(vec![0, 1], &(34 as u128));
batch.delete_key(vec![0, 1]);
let unordered_batch = batch.simplify();
assert_eq!(unordered_batch.key_prefix_deletions.len(), 0);
assert_eq!(unordered_batch.simple_unordered_batch.insertions.len(), 0);
assert_eq!(unordered_batch.simple_unordered_batch.deletions.len(), 1);

pub fn check_value_size(&self, max_value_size: usize) -> bool

Checks the size of the values of the batch.

pub fn put_key_value( &mut self, key: Vec<u8>, value: &impl Serialize, ) -> Result<(), Error>

Adds the insertion of a key-value pair into the batch with a serializable value.

let mut batch = Batch::new();
batch.put_key_value(vec![0, 1], &(34 as u128));

pub fn put_key_value_bytes(&mut self, key: Vec<u8>, value: Vec<u8>)

Adds the insertion of a (key, value) pair into the batch with value a vector of u8.

let mut batch = Batch::new();
batch.put_key_value_bytes(vec![0, 1], vec![3, 4, 5]);

pub fn delete_key(&mut self, key: Vec<u8>)

Inserts the deletion of a key into the batch.

let mut batch = Batch::new();
batch.delete_key(vec![0, 1]);

pub fn delete_key_prefix(&mut self, key_prefix: Vec<u8>)

Inserts the deletion of a key_prefix into the batch.

let mut batch = Batch::new();
batch.delete_key_prefix(vec![0, 1]);

Trait Implementations

impl Clone for Batch

fn clone(&self) -> Batch

Returns a copy 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() -> Batch

Returns the “default value” for a type.

impl PartialEq for Batch

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Batch

impl StructuralPartialEq for Batch