Skip to main content

Wal

Struct Wal 

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

Group-commit WAL writer. Append is O(buffer copy) and never fsyncs; callers (or a timer) drive Wal::sync.

Implementations§

Source§

impl Wal

Source

pub fn create(path: impl AsRef<Path>, epoch_created: Epoch) -> Result<Self>

Create a new WAL segment, truncating any existing file at path.

Source

pub fn create_with_cipher( path: impl AsRef<Path>, epoch_created: Epoch, cipher: Option<Box<dyn Cipher>>, segment_no: u64, ) -> Result<Self>

Create a new WAL segment with optional frame-level encryption. The persisted segment_no namespaces AES-GCM nonces across segments under the constant WAL DEK (spec §7.1, review fix #23).

Source

pub fn append_txn(&mut self, txn_id: u64, op: Op) -> Result<Epoch>

Append a record belonging to transaction txn_id. Assigns the next monotonic sequence (the first record after a WAL created at E gets E + 1), writes it, and returns the assigned sequence. Does NOT fsync — call Wal::sync (or rely on the byte threshold). The WAL sequence is independent of the row commit epoch; the engine tracks commit epochs separately.

Source

pub fn append_system(&mut self, op: Op) -> Result<Epoch>

Append a system record (txn_id == SYSTEM_TXN_ID), e.g. Flush.

Source

pub fn sync(&mut self) -> Result<()>

Flush the buffer and fsync the file. This is the durability point.

Source

pub fn unflushed_bytes(&self) -> u64

Pending bytes not yet fsynced.

Source

pub fn next_seq_val(&self) -> u64

The next sequence number this writer will assign (i.e. last assigned + 1). Exposed so a shared-WAL group-sync can report the durable high-water mark.

Source

pub fn set_sync_byte_threshold(&mut self, threshold: u64)

Tune the auto-sync threshold (bytes of buffered WAL before an automatic fsync). 0 disables auto-sync entirely (manual Wal::sync only) — useful for latency benchmarks and for grouping many writes under one explicit commit.

Source

pub fn path(&self) -> &Path

Trait Implementations§

Source§

impl Drop for Wal

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Wal

§

impl !UnwindSafe for Wal

§

impl Freeze for Wal

§

impl Send for Wal

§

impl Sync for Wal

§

impl Unpin for Wal

§

impl UnsafeUnpin for Wal

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.