Struct bump_scope::BumpScopeGuardRoot

pub struct BumpScopeGuardRoot<'b, A, const MIN_ALIGN: usize = 1, const UP: bool = true>
where
    MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
    A: BaseAllocator,
{ /* private fields */ }

Returned from Bump::scope_guard.

This fulfills the same purpose as BumpScopeGuard, but it does not need to store the address which the bump pointer needs to be reset to. It simply resets the bump pointer to the very start.

It is allowed to do so because it takes a &mut Bump to create this guard. This means that no allocations can be live when the guard is created.

Implementations

impl<'a, A, const MIN_ALIGN: usize, const UP: bool> BumpScopeGuardRoot<'a, A, MIN_ALIGN, UP>

where MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment, A: BaseAllocator,

pub fn scope(&mut self) -> BumpScope<'_, A, MIN_ALIGN, UP>

Returns a new BumpScope.

pub fn reset(&mut self)

Frees the memory taken up by allocations made since creation of this bump scope guard.

pub fn stats(&self) -> Stats<'_, UP>

Returns a type which provides statistics about the memory usage of the bump allocator.

pub fn guaranteed_allocated_stats(&self) -> GuaranteedAllocatedStats<'_, UP>

Returns a type which provides statistics about the memory usage of the bump allocator.

pub fn allocator(&self) -> &A

Returns a reference to the base allocator.

Trait Implementations

impl<'b, A, const MIN_ALIGN: usize, const UP: bool> Debug for BumpScopeGuardRoot<'b, A, MIN_ALIGN, UP>

where MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment, A: BaseAllocator,

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

Formats the value using the given formatter.

impl<'a, A, const MIN_ALIGN: usize, const UP: bool> Drop for BumpScopeGuardRoot<'a, A, MIN_ALIGN, UP>

where MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment, A: BaseAllocator,

fn drop(&mut self)

Executes the destructor for this type.