Struct bump_scope::Chunk

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

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

See Stats / GuaranteedAllocatedStats.

Implementations

impl<'a, const UP: bool> Chunk<'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, UP>

Returns an iterator over all previous (smaller) chunks.

pub fn iter_next(self) -> ChunkNextIter<'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.

pub fn remaining(self) -> usize

Returns the remaining capacity.

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.

Trait Implementations

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

fn clone(&self) -> Chunk<'a, UP>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<'a, const UP: bool> PartialEq for Chunk<'a, UP>

fn eq(&self, other: &Chunk<'a, UP>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method 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>

impl<'a, const UP: bool> StructuralPartialEq for Chunk<'a, UP>