Struct Stats

pub struct Stats<'a, const GUARANTEED_ALLOCATED: bool = false> { /* private fields */ }

Provides statistics about the memory usage of the bump allocator.

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

Implementations

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

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>

Returns an iterator from smallest to biggest chunk.

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

Returns an iterator from biggest to smallest chunk.

pub fn guaranteed_allocated(self) -> Option<Stats<'a, true>>

Turns this Stats into a Stats where GUARANTEED_ALLOCATED = true.

pub fn not_guaranteed_allocated(self) -> Stats<'a, false>

Turns this Stats into a Stats where GUARANTEED_ALLOCATED = false.

impl<'a> Stats<'a, true>

pub fn current_chunk(self) -> Chunk<'a>

This is the chunk we are currently allocating on.

impl<'a> Stats<'a, false>

pub fn current_chunk(self) -> Option<Chunk<'a>>

This is the chunk we are currently allocating on.

Trait Implementations

impl<'a, const GUARANTEED_ALLOCATED: bool> Clone for Stats<'a, GUARANTEED_ALLOCATED>

fn clone(&self) -> Stats<'a, GUARANTEED_ALLOCATED>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const GUARANTEED_ALLOCATED: bool> Debug for Stats<'_, GUARANTEED_ALLOCATED>

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

Formats the value using the given formatter.

impl<'a, const GUARANTEED_ALLOCATED: bool> From<Chunk<'a>> for Stats<'a, GUARANTEED_ALLOCATED>

fn from(chunk: Chunk<'a>) -> Self

Converts to this type from the input type.

impl<'a, const GUARANTEED_ALLOCATED: bool> PartialEq for Stats<'a, GUARANTEED_ALLOCATED>

fn eq(&self, other: &Stats<'a, GUARANTEED_ALLOCATED>) -> bool

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

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

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

impl<'a, const GUARANTEED_ALLOCATED: bool> Copy for Stats<'a, GUARANTEED_ALLOCATED>

impl<'a, const GUARANTEED_ALLOCATED: bool> Eq for Stats<'a, GUARANTEED_ALLOCATED>

impl<'a, const GUARANTEED_ALLOCATED: bool> StructuralPartialEq for Stats<'a, GUARANTEED_ALLOCATED>