Struct AllocationGuard

pub struct AllocationGuard<'token> { /* private fields */ }

Guard that updates the current thread to track allocations for the associated allocation group.

Drop behavior

This guard has a Drop implementation that resets the active allocation group back to the last previously active allocation group. Calling exit is generally preferred for being explicit about when the allocation group begins and ends, though.

Moving across threads

AllocationGuard is specifically marked as !Send as the active allocation group is tracked at a per-thread level. If you acquire an AllocationGuard and need to resume computation on another thread, such as across an await point or when simply sending objects to another thread, you must first exit the guard and move the resulting AllocationGroupToken. Once on the new thread, you can then reacquire the guard.

Implementations

impl<'token> AllocationGuard<'token>

pub fn exit(self)

Exits the allocation group, restoring the previously active allocation group on this thread.

Trait Implementations

impl<'token> Drop for AllocationGuard<'token>

fn drop(&mut self)

Executes the destructor for this type.