Enum lsmlite_rs::LsmMode

#[repr(C)]
pub enum LsmMode {
    LsmNoBackgroundThreads = 0,
    LsmBackgroundMerger = 1,
    LsmBackgroundCheckpointer = 2,
}

These are the different kinds of execution modes that the engine can work on. The default mode is LsmNoBackgroundThreads - in which no background thread is scheduled to perform any task. All file operations are performed by the thread that is currently writing by the database.

The other available modes are LsmBackgroundMerger in which a background thread is scheduled to merge database segments towards producing larger segments. This background thread is also in charge of checkpointing the database file - thus making data truly persistent on stable storage - and flushing in-memory data into the database file.

In mode LsmBackgroundMerger, the additional background thread only checkpoints the database file. In this mode, merge operations are performed by the thread that also writes data to the database.

In any case, file operations (like merging and checkpointing) cannot be scheduled, these operations are triggered depending on the current state of the database.

Variants

LsmNoBackgroundThreads = 0

Default mode. No additional background thread is scheduled.

LsmBackgroundMerger = 1

An additional background thread is scheduled to merge segments and to checkpoint the database file (update file headers and sync the contents of the database file to disk). This thread is also in charge of flushing in-memory data to the database file.

LsmBackgroundCheckpointer = 2

An additional background thread is scheduled to checkpoint the database file. Merge operations are not performed by this thread, but by the thread that also writes data to the database.

Trait Implementations

impl Clone for LsmMode

fn clone(&self) -> LsmMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LsmMode

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

Formats the value using the given formatter.

impl Default for LsmMode

fn default() -> LsmMode

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LsmMode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LsmMode

fn eq(&self, other: &LsmMode) -> 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 Serialize for LsmMode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<i32> for LsmMode

type Error = LsmErrorCode

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for LsmMode

impl Eq for LsmMode

impl StructuralEq for LsmMode

impl StructuralPartialEq for LsmMode