Skip to main content

WalWriter

Struct WalWriter 

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

Append-only WAL writer.

Implementations§

Source§

impl WalWriter

Source

pub fn open(path: &Path, config: WalWriterConfig) -> Result<Self>

Open or create a WAL file at the given path.

Source

pub fn set_encryption_key(&mut self, key: WalEncryptionKey)

Set the encryption key. When set, all subsequent records will have their payloads encrypted with AES-256-GCM.

Source

pub fn set_encryption_ring(&mut self, ring: KeyRing)

Set the key ring directly (for key rotation with dual-key reads).

Source

pub fn encryption_ring(&self) -> Option<&KeyRing>

Access the key ring (for decryption during replay).

Source

pub fn open_with_start_lsn( path: &Path, config: WalWriterConfig, start_lsn: u64, ) -> Result<Self>

Open a new WAL segment file with a specific starting LSN.

Used by SegmentedWal when rolling to a new segment. The file must not already exist (or be empty). The writer will assign LSNs starting from start_lsn.

Source

pub fn open_without_direct_io(path: &Path) -> Result<Self>

Open a WAL writer with O_DIRECT disabled (for testing on tmpfs, etc.).

Source

pub fn append( &mut self, record_type: u16, tenant_id: u32, vshard_id: u16, payload: &[u8], ) -> Result<u64>

Append a record to the WAL. Returns the assigned LSN.

The record is written to the in-memory buffer. Call sync() to flush to disk and make the write durable.

Source

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

Flush the write buffer to disk (group commit).

This issues a single write + fsync for all records accumulated since the last flush. The DWB is also fsynced (one fsync for all deferred DWB writes in this batch).

Source

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

Seal the WAL — no more writes will be accepted.

Flushes any buffered data before sealing.

Source

pub fn next_lsn(&self) -> u64

The next LSN that will be assigned.

Source

pub fn file_offset(&self) -> u64

Current file size (bytes written to disk).

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> 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> 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.
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