Skip to main content

PortableWalWriter

Struct PortableWalWriter 

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

Optimized WAL writer using io_uring or fallback

This writer supports both direct writes and batched operations. Batched writes can improve throughput by reducing syscall overhead.

§Batching Mode

When using batched mode:

  1. Writes are queued in a batch
  2. When batch reaches max_batch_bytes or flush_batch() is called, all writes execute
  3. Sync is deferred until batch execution

§Example

let wal = PortableWalWriter::new("wal.log", IoUringConfig::default())?;

// Direct write (immediate)
wal.append(b"entry1")?;

// Batched write (queued)
wal.append_batched(b"entry2")?;
wal.append_batched(b"entry3")?;
wal.flush_batch()?; // Execute all batched writes

Implementations§

Source§

impl PortableWalWriter

Source

pub fn new(path: impl AsRef<Path>, config: IoUringConfig) -> Result<Self>

Create a new WAL writer

Source

pub fn append(&self, data: &[u8]) -> Result<u64>

Append data to the WAL (direct write, immediate)

Source

pub fn append_batched(&self, data: &[u8]) -> Result<u64>

Append data to the WAL in batched mode

The write is queued and executed when:

  • flush_batch() is called
  • The batch exceeds max_batch_bytes

Returns the number of pending bytes in the batch

Source

pub fn flush_batch(&self) -> Result<()>

Flush all batched writes to disk

Executes all pending write operations in the batch and syncs to disk.

Source

pub fn pending_batch_bytes(&self) -> u64

Get the number of pending bytes in the batch

Source

pub fn pending_batch_ops(&self) -> usize

Get the number of pending operations in the batch

Source

pub fn has_pending_batch(&self) -> bool

Check if there are pending batched writes

Source

pub fn append_with_checksum(&self, data: &[u8]) -> Result<u64>

Append with CRC32 checksum

Source

pub fn append_with_checksum_batched(&self, data: &[u8]) -> Result<u64>

Append with CRC32 checksum in batched mode

Source

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

Flush and sync the WAL

Source

pub fn size(&self) -> u64

Get current WAL size

Source

pub fn max_batch_bytes(&self) -> u64

Get max batch bytes threshold

Source

pub fn stats(&self) -> IoUringStatsSnapshot

Get statistics

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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