Struct bump_scope::Stats

pub struct Stats<'a, const UP: bool> {
    pub current: Option<Chunk<'a, UP>>,
}

Provides statistics about the memory usage of the bump allocator.

This is returned from the stats method of Bump, BumpScope, BumpScopeGuard, BumpVec, …

Fields

current: Option<Chunk<'a, UP>>

This is the chunk we are currently allocating on.

Implementations

impl<'a, const UP: bool> Stats<'a, UP>

pub fn count(self) -> usize

Returns the number of chunks.

pub fn size(self) -> usize

Returns the total size of all chunks.

pub fn capacity(self) -> usize

Returns the total capacity of all chunks.

pub fn allocated(self) -> usize

Returns the amount of allocated bytes. This includes padding and wasted space due to reallocations.

pub fn remaining(self) -> usize

Returns the total remaining capacity of all chunks.

pub fn small_to_big(self) -> ChunkNextIter<'a, UP>

Returns an iterator from smallest to biggest chunk.

pub fn big_to_small(self) -> ChunkPrevIter<'a, UP>

Returns an iterator from biggest to smallest chunk.

pub fn to_guaranteed_allocated_stats( self, ) -> Option<GuaranteedAllocatedStats<'a, UP>>

Converts this Stats into Some(GuaranteedAllocatedStats) or None if the current chunk is None.

Trait Implementations

impl<const UP: bool> Clone for Stats<'_, UP>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, const UP: bool> Debug for Stats<'a, UP>

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

Formats the value using the given formatter.

impl<'a, const UP: bool> From<GuaranteedAllocatedStats<'a, UP>> for Stats<'a, UP>

fn from(value: GuaranteedAllocatedStats<'a, UP>) -> Self

Converts to this type from the input type.

impl<const UP: bool> PartialEq for Stats<'_, UP>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const UP: bool> Copy for Stats<'_, UP>

impl<const UP: bool> Eq for Stats<'_, UP>