Struct WriteOptions 

pub struct WriteOptions {
    pub durability: DurabilityMode,
}

Per-write options passed to commit operations.

WriteOptions lets a single write or batch request a durability level different from the database default. The options are evaluated when the write is accepted; changing a WriteOptions value later has no effect on an already committed write.

Examples

use trine_kv::{Db, WriteOptions};

let db = Db::open_sync(trine_kv::DbOptions::memory())?;
let commit = db.put_with_options_sync(b"k", b"v", WriteOptions::sync_all())?;
assert!(commit.sequence().get() > 0);

Fields

durability: DurabilityMode

Durability requested for this write.

Implementations

impl WriteOptions

pub const fn new(durability: DurabilityMode) -> Self

Creates write options with an explicit durability mode.

Parameters

• durability: durability requested for the write or batch.

pub const fn buffered() -> Self

Creates buffered write options.

The write may return after bytes are accepted by the storage backend but before a flush or sync is requested. This is the lowest-latency and weakest durability mode.

pub const fn flush() -> Self

Creates flush write options.

The write requests a backend flush for accepted WAL bytes. Exact meaning depends on the selected backend capabilities.

pub const fn sync_data() -> Self

Creates data-sync write options.

The write requests durable file data without requiring metadata sync where the backend can distinguish those operations.

pub const fn sync_all() -> Self

Creates full-sync write options.

The write requests the strongest durability mode supported by the backend for WAL data and required metadata.

Trait Implementations

impl Clone for WriteOptions

fn clone(&self) -> WriteOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WriteOptions

impl Debug for WriteOptions

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

Formats the value using the given formatter.

impl Default for WriteOptions

fn default() -> WriteOptions

Returns the “default value” for a type.

impl Eq for WriteOptions

impl PartialEq for WriteOptions

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for WriteOptions