Skip to main content

MmapWalReader

Struct MmapWalReader 

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

Memory-mapped WAL segment reader.

Opens a sealed WAL segment file via mmap and provides zero-copy iteration over records. The mmap’d region is read-only and the kernel manages page residency — no application-level memory pinning.

Implementations§

Source§

impl MmapWalReader

Source

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

Open a WAL segment file for mmap’d reading.

Source

pub fn madvise_state(&self) -> Option<c_int>

The madvise hint applied to the mapped segment (if any).

Source

pub fn release_pages(&self)

Hint to the kernel that pages for this segment can be dropped from cache. Call this after a segment has been iterated end-to-end.

Source

pub fn next_record(&mut self) -> Result<Option<WalRecord>>

Read the next record from the mmap’d region.

Returns None at EOF or at the first corruption point. Zero-copy: payload bytes reference the mmap’d region directly.

Source

pub fn records(self) -> MmapRecordIter

Iterator over all valid records in the mmap’d segment.

Source

pub fn offset(&self) -> usize

Current read offset.

Source

pub fn len(&self) -> usize

Total size of the mmap’d region.

Source

pub fn is_empty(&self) -> bool

Whether the mmap’d region is empty.

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