Skip to main content

CommitPolicy

Struct CommitPolicy 

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

When crate::Salamander::append should trigger an automatic commit() on the caller’s behalf.

Thresholds are combinable — set any subset with the and_* builders; a commit fires when any active threshold is crossed. Byte and count thresholds are exact (checked after every append, so a crossing commits immediately). The time threshold is best-effort: with no background thread in Phase 1.5 (that’s a Phase 3 concern), it can only be noticed on the next append after the interval has elapsed — an idle DB does not self-commit.

use salamander::CommitPolicy;
// fsync every 64 KiB *or* every 200 ms, whichever comes first:
let policy = CommitPolicy::every_bytes(64 * 1024).and_millis(200);

Implementations§

Source§

impl CommitPolicy

Source

pub const fn manual() -> Self

No auto-commit — the caller drives durability by calling commit() itself. This is the default (CommitPolicy::default()).

Source

pub const fn every_bytes(bytes: u64) -> Self

Commit once this many uncommitted payload bytes have accumulated.

Source

pub const fn every_count(count: u64) -> Self

Commit once this many events have been appended since the last commit.

Source

pub const fn every_millis(millis: u64) -> Self

Commit on the first append at least this many milliseconds after the last commit (best-effort — see the type docs).

Source

pub const fn and_bytes(self, bytes: u64) -> Self

Add a byte threshold to an existing policy (combinable).

Source

pub const fn and_count(self, count: u64) -> Self

Add a count threshold to an existing policy (combinable).

Source

pub const fn and_millis(self, millis: u64) -> Self

Add a time threshold to an existing policy (combinable).

Trait Implementations§

Source§

impl Clone for CommitPolicy

Source§

fn clone(&self) -> CommitPolicy

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 CommitPolicy

Source§

impl Debug for CommitPolicy

Source§

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

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

impl Default for CommitPolicy

Source§

fn default() -> CommitPolicy

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

impl Eq for CommitPolicy

Source§

impl PartialEq for CommitPolicy

Source§

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

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.