Skip to main content

StorageWriteAheadLog

Struct StorageWriteAheadLog 

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

In-memory write-ahead log for crash-safe block operations.

Unlike WriteAheadLog which is CID-centric and thread-safe via Mutex/AtomicU64, StorageWriteAheadLog is a single-threaded, tick-driven WAL that tracks total data bytes and supports indexed checkpoint replay.

Implementations§

Source§

impl StorageWriteAheadLog

Source

pub fn new(config: WalConfig) -> Self

Creates a new StorageWriteAheadLog with the given configuration.

Source

pub fn append( &mut self, kind: WalEntryKind, key: &str, data: Vec<u8>, ) -> Result<u64, String>

Appends a new entry to the WAL.

If appending would exceed max_entries, the oldest entry is evicted first. Returns the assigned sequence number.

§Errors

Returns an error if adding data would exceed max_data_bytes.

Source

pub fn get_entry(&self, sequence: u64) -> Option<&StorageWalEntry>

Returns a reference to the entry with the given sequence number, if present.

Source

pub fn entries_since(&self, sequence: u64) -> Vec<&StorageWalEntry>

Returns references to all entries with sequence numbers strictly greater than sequence.

Source

pub fn create_checkpoint(&mut self) -> u64

Records the current head sequence as a checkpoint and returns it.

Source

pub fn truncate_before(&mut self, sequence: u64)

Removes all entries with sequence numbers strictly less than sequence, updating total_data_bytes accordingly.

Source

pub fn replay_from_checkpoint( &self, checkpoint_idx: usize, ) -> Result<Vec<&StorageWalEntry>, String>

Returns all entries from the given checkpoint index to the end.

§Errors

Returns an error if checkpoint_idx is out of range.

Source

pub fn should_checkpoint(&self) -> bool

Returns true if the number of ticks since the last checkpoint is at least checkpoint_interval.

Source

pub fn tick(&mut self)

Advances the logical clock by one tick.

Source

pub fn entry_count(&self) -> usize

Returns the number of entries currently in the log.

Source

pub fn data_bytes(&self) -> u64

Returns the total data bytes across all entries.

Source

pub fn stats(&self) -> StorageWalStats

Returns a point-in-time statistics snapshot.

Trait Implementations§

Source§

impl Debug for StorageWriteAheadLog

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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> 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> 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> 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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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