Skip to main content

AdaptiveCachePolicy

Struct AdaptiveCachePolicy 

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

Read-only policy object that reads ResourceGuard::pressure() and produces cache directives. Does not own any cache — it only tells other code what to do.

Use AdaptiveCachePolicy::new_with_guard when sharing a ResourceGuard with a builder or other subsystem (recommended). Use AdaptiveCachePolicy::new when the cache policy needs its own independent ceiling.

Implementations§

Source§

impl AdaptiveCachePolicy

Source

pub fn new(ceiling_fraction: f64) -> Self

Creates a new policy with the given ceiling fraction of system memory.

For example, 0.6 means use 60 % of system memory as the ceiling. Internally delegates to ResourceGuard::auto(ceiling_fraction).

Source

pub fn new_with_guard(guard: ResourceGuard, ceiling_bytes: usize) -> Self

Creates a policy sharing an existing ResourceGuard.

This is the recommended constructor for daemons: one guard governs both the builder’s safety checks AND the cache’s pressure readings, so they never disagree about how much memory is available.

ceiling_bytes must match the guard’s internal ceiling (i.e., the value passed to ResourceGuard::new or computed by auto).

Source

pub fn guard(&self) -> &ResourceGuard

Returns a reference to the underlying ResourceGuard.

Source

pub fn directive(&self) -> CacheDirective

Returns a CacheDirective reflecting the current memory pressure.

⚠ BLOCKING: This call internally invokes ResourceGuard::pressure() which reads /proc/stat twice with a 100 ms sleep between reads on Linux (via raw_entropy() / delta_iowait_ratio()). Do not call this in an async context without spawn_blocking.

§Zone mapping
ZonePressureevict_fractionallow_new_entriesallow_mmap_pin
Green0–400.0truetrue
Yellow41–700.1truetrue
Orange71–900.5falsefalse
Red91–1001.0falsefalse
Source

pub fn pressure(&self) -> u8

Convenience wrapper for ResourceGuard::pressure().

⚠ BLOCKING: See directive for blocking details.

Source

pub fn rss_bytes(&self) -> usize

Returns the current RSS in bytes.

Source

pub fn ceiling_bytes(&self) -> usize

Returns the memory ceiling in bytes that this policy is configured with.

Trait Implementations§

Source§

impl Debug for AdaptiveCachePolicy

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