Struct Pool 

pub struct Pool { /* private fields */ }

A shared byte budget that caches charge into; cloning shares the same budget.

The pool tracks how many payload bytes are cached across every registered group and evicts the least-recently-read groups once used exceeds capacity. Eviction aborts the victim group with Error::Evicted, which frees its frames immediately and wakes any parked readers. Pinned (latest) groups are never evicted but still count against the budget.

Reads and writes only touch atomics; the internal lock is taken when a group registers/unregisters and when the pool is actually over budget.

Implementations

impl Pool

pub fn new(capacity: u64) -> Self

Create a pool that evicts once capacity bytes are cached.

The budget counts frame payload bytes (plus a small fixed overhead per group), not process RSS; leave headroom when sizing it from real memory.

pub fn unbounded() -> Self

Create a pool that never evicts. This is the Default.

pub fn capacity(&self) -> Option<u64>

The configured capacity in bytes, or None when unbounded.

pub fn used(&self) -> u64

Bytes currently cached across every registered group.

pub fn resize(&self, capacity: impl Into<Option<u64>>)

Change the capacity, evicting immediately if the new capacity is exceeded. None makes the pool unbounded.

pub fn same_pool(&self, other: &Self) -> bool

Returns true if both handles share the same underlying pool.

Trait Implementations

impl Clone for Pool

fn clone(&self) -> Pool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pool

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

Formats the value using the given formatter.

impl Default for Pool

fn default() -> Pool

Returns the “default value” for a type.