Skip to main content

CacheManager

Struct CacheManager 

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

Manages cache lifecycle: freshness check, rebuild, and fallback to TSJSON.

§Usage

use bones_core::cache::manager::CacheManager;

let mgr = CacheManager::new(".bones/events", ".bones/cache/events.bin");
let events = mgr.load_events().unwrap();

Implementations§

Source§

impl CacheManager

Source

pub fn new( events_dir: impl Into<PathBuf>, cache_path: impl Into<PathBuf>, ) -> Self

Create a new cache manager.

§Arguments
  • events_dir — Path to .bones/events/ shard directory.
  • cache_path — Path to .bones/cache/events.bin.
Source

pub fn is_fresh(&self) -> Result<bool>

Check whether the cache file exists and is fresh.

Returns true if:

  • The cache file exists and can be opened.
  • The stored fingerprint matches the current shard fingerprint.

Returns false otherwise (missing, corrupt, stale, or on any error).

§Errors

Returns an error if computing the shard fingerprint fails.

Source

pub fn load_events(&self) -> Result<LoadResult>

Load events, preferring the binary cache when fresh.

  1. Compute a fingerprint over event shard files.
  2. If cache exists and fingerprint matches → decode from cache.
  3. Otherwise → parse TSJSON, then rebuild the cache in the foreground (so next call is fast). Cache rebuild failures are logged but do not cause the load to fail.
§Errors

Returns an error only if TSJSON parsing itself fails. Cache errors are handled by falling back to TSJSON.

Source

pub fn rebuild(&self) -> Result<CacheStats>

Force a cache rebuild from TSJSON event shards.

Returns statistics about the rebuilt cache.

§Errors

Returns an error if shard replay, parsing, or cache writing fails.

Source

pub fn events_dir(&self) -> &Path

Return the path to the events directory.

Source

pub fn cache_path(&self) -> &Path

Return the path to the cache file.

Trait Implementations§

Source§

impl Clone for CacheManager

Source§

fn clone(&self) -> CacheManager

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CacheManager

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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