Struct Chunk 

pub struct Chunk<'a, A, const UP: bool> { /* private fields */ }

Refers to a chunk of memory that was allocated by the bump allocator.

See Stats.

Implementations

impl<'a, A, const UP: bool> Chunk<'a, A, UP>

pub fn prev(self) -> Option<Self>

Returns the previous (smaller) chunk.

pub fn next(self) -> Option<Self>

Returns the next (bigger) chunk.

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

Returns an iterator over all previous (smaller) chunks.

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

Returns an iterator over all next (bigger) chunks.

pub fn size(self) -> usize

Returns the size of this chunk in bytes.

pub fn capacity(self) -> usize

Returns the capacity of this chunk in bytes.

pub fn allocated(self) -> usize

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

This property can be misleading for chunks that come after the current chunk because their bump_position and consequently the allocated property is not reset until they become the current chunk again.

pub fn remaining(self) -> usize

Returns the remaining capacity.

This property can be misleading for chunks that come after the current chunk because their bump_position and consequently the remaining property is not reset until they become the current chunk again.

pub fn chunk_start(self) -> NonNull<u8>

Returns a pointer to the start of the chunk.

pub fn chunk_end(self) -> NonNull<u8>

Returns a pointer to the end of the chunk.

pub fn content_start(self) -> NonNull<u8>

Returns a pointer to the start of the chunk’s content.

pub fn content_end(self) -> NonNull<u8>

Returns a pointer to the end of the chunk’s content.

pub fn bump_position(self) -> NonNull<u8>

Returns the bump pointer. It lies within the chunk’s content range.

This property can be misleading for chunks that come after the current chunk because their bump_position is not reset until they become the current chunk again.

pub fn allocator(&self) -> &'a A

Returns a reference to the base allocator.

Trait Implementations

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

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> Debug for Chunk<'_, A, UP>

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

Formats the value using the given formatter.

impl<A, const UP: bool> From<Chunk<'_, A, UP>> for AnyChunk<'_>

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

Converts to this type from the input 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> PartialEq for Chunk<'_, A, UP>

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> Copy for Chunk<'_, A, UP>

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