Struct Batch 

pub struct Batch { /* private fields */ }

Available on crate feature std only.

An ordered group of writes applied together.

Operations are recorded in call order and replayed in that order when the batch is written, so a later operation on a key overrides an earlier one.

Examples

use lsm_db::Batch;

let mut batch = Batch::new();
batch.put(b"alpha", b"1");
batch.put(b"beta", b"2");
batch.delete(b"gamma");
assert_eq!(batch.len(), 3);

Implementations

impl Batch

pub fn new() -> Self

Create an empty batch.

Examples

use lsm_db::Batch;
let batch = Batch::new();
assert!(batch.is_empty());

pub fn put(&mut self, key: impl AsRef<[u8]>, value: impl AsRef<[u8]>)

Queue setting key to value.

Both are copied into the batch, so the caller’s buffers are free to be reused immediately.

Examples

use lsm_db::Batch;
let mut batch = Batch::new();
batch.put(b"key", b"value");
assert_eq!(batch.len(), 1);

pub fn delete(&mut self, key: impl AsRef<[u8]>)

Queue deleting key.

Examples

use lsm_db::Batch;
let mut batch = Batch::new();
batch.delete(b"key");
assert_eq!(batch.len(), 1);

pub fn len(&self) -> usize

The number of queued operations.

pub fn is_empty(&self) -> bool

Whether the batch has no queued operations.

Trait Implementations

impl Clone for Batch

fn clone(&self) -> Batch

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() -> Batch

Returns the “default value” for a type.