Skip to main content

AsyncWalManager

Struct AsyncWalManager 

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

Async Write-Ahead Log manager with non-blocking I/O.

This manager provides the same durability guarantees as the sync version but uses tokio’s async I/O for better throughput in async contexts.

Implementations§

Source§

impl AsyncWalManager

Source

pub async fn open(dir: impl AsRef<Path>) -> Result<Self>

Opens or creates an async WAL in the given directory.

§Errors

Returns an error if the directory cannot be created or accessed.

Source

pub async fn with_config( dir: impl AsRef<Path>, config: WalConfig, ) -> Result<Self>

Opens or creates an async WAL with custom configuration.

§Errors

Returns an error if the directory cannot be created or accessed.

Source

pub async fn log(&self, record: &WalRecord) -> Result<()>

Logs a record to the WAL asynchronously.

§Errors

Returns an error if the record cannot be written.

Source

pub async fn checkpoint(&self, current_tx: TxId, epoch: EpochId) -> Result<()>

Writes a checkpoint marker and returns the checkpoint info.

§Errors

Returns an error if the checkpoint cannot be written.

Source

pub async fn rotate(&self) -> Result<()>

Rotates to a new log file.

§Errors

Returns an error if rotation fails.

Source

pub async fn flush(&self) -> Result<()>

Flushes the WAL buffer to disk.

§Errors

Returns an error if the flush fails.

Source

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

Syncs the WAL to disk (fsync).

§Errors

Returns an error if the sync fails.

Source

pub async fn start_background_sync(&self) -> bool

Starts a background sync task for batch durability mode.

The task will periodically sync the WAL based on the batch configuration. This is useful when you want automatic syncing without waiting for individual log calls to trigger it.

§Returns

Returns true if a new background task was started, false if batch mode is not configured or a task is already running.

Source

pub async fn stop_background_sync(&self)

Stops the background sync task if running.

Source

pub fn record_count(&self) -> u64

Returns the total number of records written.

Source

pub fn dir(&self) -> &Path

Returns the WAL directory path.

Source

pub fn durability_mode(&self) -> DurabilityMode

Returns the current durability mode.

Source

pub async fn log_files(&self) -> Result<Vec<PathBuf>>

Returns all WAL log file paths in sequence order.

Source

pub async fn checkpoint_epoch(&self) -> Option<EpochId>

Returns the latest checkpoint epoch, if any.

Trait Implementations§

Source§

impl Drop for AsyncWalManager

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

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