Skip to main content

WriteBatch

Struct WriteBatch 

Source
pub struct WriteBatch { /* private fields */ }
Expand description

Batch of write operations applied with a shared seqno.

Duplicate keys: all entries receive the same seqno. The memtable skiplist orders by (user_key, Reverse(seqno))value_type does NOT break ties. Two entries with the same (user_key, seqno) compare equal regardless of operation type, so one may silently overwrite the other.

  • Repeated merge() on the same key: safe. All merge operands are collected during reads regardless of skiplist position.
  • Mixed ops on the same key (e.g. insert + remove): not allowed. materialize() rejects these batches with Error::MixedOperationBatch in all builds. Callers must canonicalize mixed-op duplicates into a single final operation before batching.

§Examples

use lsm_tree::WriteBatch;

let mut batch = WriteBatch::new();
batch.insert("key1", "value1");
batch.insert("key2", "value2");
batch.remove("key3");

assert_eq!(batch.len(), 3);
assert!(!batch.is_empty());

Implementations§

Source§

impl WriteBatch

Source

pub fn new() -> Self

Creates an empty write batch.

Source

pub fn with_capacity(capacity: usize) -> Self

Creates an empty write batch with the given capacity.

Source

pub fn insert<K: Into<UserKey>, V: Into<UserValue>>(&mut self, key: K, value: V)

Inserts a key-value pair into the batch.

Source

pub fn remove<K: Into<UserKey>>(&mut self, key: K)

Adds a delete (tombstone) for a key.

Source

pub fn remove_weak<K: Into<UserKey>>(&mut self, key: K)

Adds a weak delete (single-delete tombstone) for a key.

Source

pub fn merge<K: Into<UserKey>, V: Into<UserValue>>(&mut self, key: K, value: V)

Adds a merge operand for a key.

Multiple merge() calls for the same key within one batch are supported: they produce distinct merge operands that are resolved together during reads (via the configured MergeOperator). The duplicate-key warning in the struct doc applies to mixed operation types (e.g. insert + remove on the same key), not to multiple merges.

Source

pub fn len(&self) -> usize

Returns the number of operations in the batch.

Source

pub fn is_empty(&self) -> bool

Returns true if the batch contains no operations.

Source

pub fn clear(&mut self)

Clears the batch, removing all entries.

Trait Implementations§

Source§

impl Clone for WriteBatch

Source§

fn clone(&self) -> WriteBatch

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WriteBatch

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WriteBatch

Source§

fn default() -> WriteBatch

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.