Skip to main content

PoolStats

Struct PoolStats 

Source
pub struct PoolStats {
    pub hits: AtomicUsize,
    pub misses: AtomicUsize,
    pub checked_out: AtomicUsize,
    pub peak_checked_out: AtomicUsize,
    pub bytes_checked_out: AtomicUsize,
    pub peak_bytes_checked_out: AtomicUsize,
}
Expand description

Pool statistics for observability.

All counters use relaxed atomics and are safe to read from any thread.

§Example

use santh_bufpool::{BufferPool, PoolConfig};

let pool = BufferPool::new(PoolConfig::default());
let buf = pool.checkout(64).unwrap();
let stats = pool.stats().snapshot();
assert_eq!(stats.checked_out, 1);
drop(buf);

Fields§

§hits: AtomicUsize

Number of successful checkouts from the pool (reuse).

§misses: AtomicUsize

Number of fallback allocations (pool exhausted).

§checked_out: AtomicUsize

Number of buffers currently checked out.

§peak_checked_out: AtomicUsize

Peak simultaneous checkouts observed.

§bytes_checked_out: AtomicUsize

Total bytes currently checked out (sum of requested sizes).

§peak_bytes_checked_out: AtomicUsize

Peak bytes checked out simultaneously.

Implementations§

Source§

impl PoolStats

Source

pub fn snapshot(&self) -> PoolStatsSnapshot

Snapshot the current stats.

§Example
use santh_bufpool::{BufferPool, PoolConfig};

let pool = BufferPool::new(PoolConfig::default());
let snapshot = pool.stats().snapshot();
assert_eq!(snapshot.hits, 0);

Trait Implementations§

Source§

impl Debug for PoolStats

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PoolStats

Source§

fn default() -> PoolStats

Returns the “default value” for a type. 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, 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, 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.