Struct Stats 

pub struct Stats<'a, A = Global, const UP: bool = true, const GUARANTEED_ALLOCATED: bool = true> { /* private fields */ }

Provides statistics about the memory usage of the bump allocator.

This is returned from the stats method of Bump and BumpScope.

Implementations

impl<'a, A, const UP: bool, const GUARANTEED_ALLOCATED: bool> Stats<'a, A, UP, 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.

This is equal to the allocated bytes of the current chunk plus the capacity of all previous chunks.

pub fn remaining(self) -> usize

Returns the remaining capacity in bytes.

This is equal to the remaining capacity of the current chunk plus the capacity of all following chunks.

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

Returns an iterator from smallest to biggest chunk.

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

Returns an iterator from biggest to smallest chunk.

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

Turns this Stats into a Stats where GUARANTEED_ALLOCATED = true.

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

Turns this Stats into a Stats where GUARANTEED_ALLOCATED = false.

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

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

This is the chunk we are currently allocating on.

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

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

This is the chunk we are currently allocating on.

Trait Implementations

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<A, const UP: bool> Default for Stats<'_, A, UP, false>

fn default() -> Self

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl<A, const UP: bool, const GUARANTEED_ALLOCATED: bool> From<Stats<'_, A, UP, GUARANTEED_ALLOCATED>> for AnyStats<'_>

fn from(value: Stats<'_, A, UP, GUARANTEED_ALLOCATED>) -> Self

Converts to this type from the input type.

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

fn eq(&self, other: &Self) -> 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 UP: bool, const GUARANTEED_ALLOCATED: bool> Copy for Stats<'_, A, UP, GUARANTEED_ALLOCATED>

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