Skip to main content

IndexedSnapshot

Struct IndexedSnapshot 

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

A single-consumer bounded view of a valid native journal index graph.

Open while appends, rotation and truncation are excluded by the caller. After capture, supported append-only writers may resume. In-place mutation and truncation are unsupported. Uncertain files require verify_index first. This API never falls back to a row scan for an indexed operation. .journal.zst uses whole-file staging and therefore has full-file decompression opening cost.

Implementations§

Source§

impl IndexedSnapshot

Source

pub fn open( path: impl AsRef<Path>, options: IndexedSnapshotOptions, control: &SnapshotControl<'_>, ) -> Result<Self>

Source

pub fn entry_count(&self) -> u64

Source

pub fn is_archived(&self) -> bool

Whether the captured header was archived. This remains fixed if the file is archived later; it does not certify index integrity.

Source

pub fn captured_value(&self, name: &[u8], value: &[u8]) -> Result<CapturedValue>

Source

pub fn visit_match( &mut self, name: &[u8], value: &[u8], control: &SnapshotControl<'_>, visit: impl FnMut(&mut SnapshotEntry<'_>) -> Result<()>, ) -> Result<()>

Source

pub fn visit_field( &mut self, name: &[u8], control: &SnapshotControl<'_>, accept: impl FnMut(&[u8]) -> Result<bool>, visit: impl FnMut(&mut SnapshotEntry<'_>) -> Result<()>, ) -> Result<()>

Streams postings for every accepted value; multivalued rows may repeat. No union, deduplication, or sorting is performed.

Source

pub fn visit_entries( &mut self, control: &SnapshotControl<'_>, visit: impl FnMut(&mut SnapshotEntry<'_>) -> Result<()>, ) -> Result<()>

Lazily streams all captured entries, with O(entries) work and bounded chunks.

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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