Skip to main content

ChunkCache

Struct ChunkCache 

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

On-disk chunk cache for decoded xorb ranges, keyed by the 64-hex xorb hash.

See the module docs for layout, atomicity, corruption handling, and the LRU budget/eviction mechanics.

Implementations§

Source§

impl ChunkCache

Source

pub fn new( cache_dir: impl Into<PathBuf>, budget_bytes: u64, ) -> Result<Self, SdxError>

Creates a cache rooted at cache_dir with an LRU budget of budget_bytes (0 disables the cache).

Existing entries are scanned and validated; corrupt or oversized files are removed, and entries over the budget are evicted (oldest first).

§Errors

Returns SdxError::Io when cache_dir cannot be created or scanned.

Source

pub fn cache_dir(&self) -> &Path

Returns the cache root directory.

Source

pub const fn budget_bytes(&self) -> u64

Returns the configured budget in bytes (0 = disabled).

Source

pub async fn total_bytes(&self) -> Result<u64, SdxError>

Returns the total bytes currently tracked by this cache instance.

§Errors

Returns SdxError::StreamInternal when the cache state lock is poisoned.

Source

pub async fn entry_count(&self) -> Result<usize, SdxError>

Returns the number of entries currently tracked by this cache instance.

§Errors

Returns SdxError::StreamInternal when the cache state lock is poisoned.

Source

pub async fn get( &self, xorb_hash: &str, chunk_range: (u64, u64), ) -> Result<Option<CachedXorbRange>, SdxError>

Returns the cached decoded xorb range for xorb_hash covering exactly chunk_range, or None on a miss.

A corrupt or truncated entry is deleted and reported as a miss; no error is propagated for data-level corruption.

§Errors

Returns SdxError::Hash when xorb_hash is not a valid 64-hex Xet CAS API hash, or SdxError::Io when reading fails.

Source

pub async fn put( &self, xorb_hash: &str, chunk_range: (u64, u64), chunk_offsets: &[u32], data: &[u8], ) -> Result<(), SdxError>

Stores the decoded xorb range data/chunk_offsets under xorb_hash for chunk_range.

chunk_offsets must have chunk_end - chunk_start + 1 entries, the first must be 0, and the last must equal data.len() (validated; invalid input is rejected with SdxError::StreamInternal). Entries may cover at most 8192 chunks. Entries larger than the budget are not stored. On overflow, the least-recently-accessed entry is evicted until the cache fits.

§Errors

Returns SdxError::Hash when xorb_hash is invalid, SdxError::StreamInternal when the entry shape is invalid, or SdxError::Io when writing or evicting fails.

Trait Implementations§

Source§

impl Debug for ChunkCache

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. 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> DropFlavorWrapper<T> for T

Source§

type Flavor = MayDrop

The DropFlavor that wraps T into Self
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<E> ResultError for E
where E: Send + Debug + Sync,

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