Skip to main content

CachedBlockReader

Struct CachedBlockReader 

Source
pub struct CachedBlockReader<S, C> { /* private fields */ }
Expand description

Read-only block reader wrapper that consults a local file-style cache.

The cache file contains a compact header, a per-block validity bitmap, and raw backing bytes. Misses are fetched from the inner reader, written into the data region, and marked valid.

The cache flushes automatically after writing flush_every_blocks new blocks to ensure persistence across sessions. There is no dirty flag; the bitmap is the authoritative source of validity.

Implementations§

Source§

impl<S, C> CachedBlockReader<S, C>
where S: BlockReader, C: CacheOps,

Source

pub async fn new(inner: S, cache: C) -> GibbloxResult<Self>

Construct a cached reader using the default flush policy.

Source

pub async fn with_flush_block_limit( inner: S, cache: C, flush_every_blocks: u32, ) -> GibbloxResult<Self>

Construct a cached reader with a custom flush threshold.

The cache will flush after writing flush_every_blocks newly cached blocks. Lower values provide better crash resilience at the cost of more frequent I/O. A value of 1 flushes after every write batch (maximally safe but slowest).

Source

pub async fn flush_cache(&self) -> GibbloxResult<()>

Force a cache flush and clear the dirty bit if there are pending writes.

Source

pub async fn get_stats(&self) -> CacheStats

Return a snapshot of cache statistics.

Source

pub async fn ensure_cached( &self, lba: u64, blocks: u64, ctx: ReadContext, ) -> GibbloxResult<()>

Ensure blocks [lba, lba+blocks) are cached without copying data out.

This fetches any missing blocks from the inner reader and populates the cache without allocating or returning a caller buffer.

Already-cached blocks are skipped (bitmap check only). The provided ReadContext propagates priority hints to the inner reader.

Trait Implementations§

Source§

impl<S, C> BlockReader for CachedBlockReader<S, C>
where S: BlockReader, C: CacheOps,

Source§

fn block_size(&self) -> u32

Logical block size in bytes.
Source§

fn total_blocks<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = GibbloxResult<u64>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Total number of logical blocks available.
Source§

fn write_identity(&self, out: &mut dyn Write) -> Result

Write a stable, canonical identity string for this block reader.
Source§

fn read_blocks<'life0, 'life1, 'async_trait>( &'life0 self, lba: u64, buf: &'life1 mut [u8], ctx: ReadContext, ) -> Pin<Box<dyn Future<Output = GibbloxResult<usize>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read one or more blocks starting at lba into buf. Read more

Auto Trait Implementations§

§

impl<S, C> !Freeze for CachedBlockReader<S, C>

§

impl<S, C> !RefUnwindSafe for CachedBlockReader<S, C>

§

impl<S, C> Send for CachedBlockReader<S, C>
where S: Send, C: Send,

§

impl<S, C> Sync for CachedBlockReader<S, C>
where S: Sync, C: Sync,

§

impl<S, C> Unpin for CachedBlockReader<S, C>
where S: Unpin, C: Unpin,

§

impl<S, C> UnsafeUnpin for CachedBlockReader<S, C>
where S: UnsafeUnpin, C: UnsafeUnpin,

§

impl<S, C> !UnwindSafe for CachedBlockReader<S, C>

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