Skip to main content

BlockCacheManager

Struct BlockCacheManager 

Source
pub struct BlockCacheManager {
    pub config: BcmCacheConfig,
    pub hot: HashMap<String, BcmCachedBlock>,
    pub warm: HashMap<String, BcmCachedBlock>,
    pub cold: HashMap<String, BcmCachedBlock>,
    /* private fields */
}
Expand description

A multi-tier, policy-driven block cache.

Blocks are stored across three tiers (ColdWarmHot) and migrate upward based on access frequency thresholds and downward via explicit demote calls or administrator policy.

Fields§

§config: BcmCacheConfig

Cache configuration.

§hot: HashMap<String, BcmCachedBlock>§warm: HashMap<String, BcmCachedBlock>§cold: HashMap<String, BcmCachedBlock>

Implementations§

Source§

impl BlockCacheManager

Source

pub fn new(config: BcmCacheConfig) -> Self

Create a new BlockCacheManager with the given configuration.

Source

pub fn insert(&mut self, cid: String, data: Vec<u8>, now: u64) -> bool

Insert a block into the Cold tier.

Returns false if the CID is already present in any tier. If the Cold tier is full, attempts eviction before inserting.

Source

pub fn get(&mut self, cid: &str, now: u64) -> Option<&[u8]>

Return a reference to the block data, or None if not present.

Updates access_count and last_accessed, then checks whether the block should be promoted to a higher tier.

Source

pub fn pin(&mut self, cid: &str) -> bool

Mark a block as pinned so it cannot be evicted. Returns false if not found.

Source

pub fn unpin(&mut self, cid: &str) -> bool

Remove the pin from a block, allowing it to be evicted again. Returns false if not found.

Source

pub fn evict_to_fit( &mut self, tier: CacheTier, needed_bytes: u64, now: u64, ) -> u64

Evict unpinned blocks from tier until at least needed_bytes have been freed.

Returns the total number of bytes actually freed. Pinned blocks are never evicted; if only pinned blocks remain, eviction stops early.

Source

pub fn promote(&mut self, cid: &str, now: u64)

Check whether the block identified by cid should be promoted to a higher tier based on its current access_count, and move it if so.

Promotion chain:

  • Cold → Warm if access_count >= warm_threshold
  • Warm → Hot if access_count >= hot_threshold
Source

pub fn demote(&mut self, cid: &str, now: u64)

Move a block one tier down. Has no effect if the block is in Cold tier or not found.

Source

pub fn total_hot_bytes(&self) -> u64

Total bytes used by the Hot tier.

Source

pub fn total_warm_bytes(&self) -> u64

Total bytes used by the Warm tier.

Source

pub fn total_cold_bytes(&self) -> u64

Total bytes used by the Cold tier.

Source

pub fn total_bytes(&self) -> u64

Total bytes across all tiers.

Source

pub fn len(&self) -> usize

Total number of blocks across all tiers.

Source

pub fn is_empty(&self) -> bool

true if no blocks are currently cached.

Source

pub fn remove(&mut self, cid: &str) -> bool

Remove a block from the cache, regardless of tier.

Returns false if the block is pinned or not found.

Source

pub fn contains(&self, cid: &str) -> bool

Return true if the CID is cached in any tier.

Source

pub fn tier_of(&self, cid: &str) -> Option<CacheTier>

Return which tier the block lives in, or None if not cached.

Source

pub fn stats(&self) -> BcmCacheStats

Snapshot of current cache statistics.

Trait Implementations§

Source§

impl Debug for BlockCacheManager

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> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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