Skip to main content

DurabilityPolicy

Enum DurabilityPolicy 

Source
#[non_exhaustive]
pub enum DurabilityPolicy { Maximal, Segment, Throughput, }
Expand description

Per-flush durability tradeoff between throughput and crash safety.

Selects how many fsyncs the write path performs when flush spills a batch to disk. Higher durability costs throughput; lower durability relies on the cloud (or wherever the durable copy lives) to absorb crash loss. Since v0.6.0, Throughput is the default: the crate’s target use case is the local throughput buffer in front of cloud sync, where the cloud endpoint is the durable layer.

§Crash-loss semantics

PolicyFsync file dataFsync dir after renameWorst-case crash loss
Maximalyesyeslast in-flight flush only
Segmentyesnorename window (~5–30s of flushes on ext4/xfs)
Throughputnonoentire OS dirty window (~30s) — cloud is durable

Maximal is for standalone-queue deployments where this buffer is the last copy. Throughput (the default since v0.6.0) is the correct choice for cloud-sync deployments where the cloud endpoint holds the durable copy and the local disk is a throughput buffer. Segment is the pre-v0.6.0 default.

§The rename-window gap (why Segment is not “fully durable”)

Segment (the pre-v0.6.0 default) calls file.sync_all() on the segment data before fs::rename, but it does not dir.sync_all() after the rename. On ext4/xfs defaults, a host crash within the kernel’s dir-inode flush window (~5–30s) can leave the renamed file’s data on disk but unreachable through the directory. SQLite went through this exact lesson. So Segment was already not fully durable; the enum just makes the tradeoff explicit. Maximal closes the rename-window gap.

§Implementation

The policy is branched on inside SegmentStore::write_atomic (not a callback): it is a Copy enum with no allocation, and the Mutex<Compressor> invariant (“never held across I/O”) is preserved because the fsync happens after compression is done and the mutex is released.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Maximal

Fsync the segment file’s data and the parent directory inode after rename. Closes the rename-window gap. Use when this buffer is the last copy of the data (standalone-queue deployments).

§

Segment

Fsync the segment file’s data, but not the directory inode after rename. This is the pre-v0.6.0 default. A host crash within the kernel’s directory-inode flush window (~5–30s on ext4/xfs defaults) can leave the renamed file’s data on disk but unreachable through the directory. Select explicitly for standalone-queue deployments that prefer the pre-v0.6.0 behavior over Maximal.

§

Throughput

Skip fsync entirely. The kernel’s dirty-page flusher handles when the bytes reach disk (~30s on default Linux). The rename is still atomic, so concurrent readers never see a partial write — only a host crash within the dirty window can lose the segment. This is the Default since v0.6.0: the cloud is the durable layer and this buffer is the throughput buffer in front of it.

Trait Implementations§

Source§

impl Clone for DurabilityPolicy

Source§

fn clone(&self) -> DurabilityPolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for DurabilityPolicy

Source§

impl Debug for DurabilityPolicy

Source§

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

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

impl Default for DurabilityPolicy

Source§

fn default() -> DurabilityPolicy

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

impl Display for DurabilityPolicy

Source§

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

Human-readable representation suitable for logging and diagnostics.

The format is a single lowercase word per variant, stable across releases so operators can grep for it in log output.

Source§

impl Eq for DurabilityPolicy

Source§

impl PartialEq for DurabilityPolicy

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DurabilityPolicy

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more