Skip to main content

WalWriter

Struct WalWriter 

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

Appends LogEntry values to a segment-based WAL on disk.

Segment files are named wal-{segment_id:08}.seg inside the configured directory. When the current segment exceeds max_segment_size a new segment is created automatically.

Implementations§

Source§

impl WalWriter

Source

pub fn new( dir: &Path, sync_mode: SyncMode, max_segment_size: u64, ) -> RaftResult<Self>

Create a new writer rooted at dir.

The directory is created if it does not exist. Any existing segments are discovered so that new writes continue from the latest segment.

Source

pub fn append(&mut self, entry: &LogEntry) -> RaftResult<()>

Append a single log entry to the WAL.

Rotates to a new segment when the current one exceeds the configured maximum size. Calls fsync according to the configured SyncMode.

Source

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

Force an fsync on the current segment, regardless of SyncMode.

Source

pub fn truncate_from(&mut self, from_index: LogIndex) -> RaftResult<()>

Truncate all entries with index >= from_index.

This rewrites segment files, removing entries at or beyond the given index. After truncation the writer re-opens the last remaining segment (or creates a fresh one if all entries were removed).

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