Struct MemoryGrant 

pub struct MemoryGrant { /* private fields */ }

RAII wrapper for memory allocations.

Automatically releases memory back to the BufferManager when dropped. Use consume() to transfer ownership without releasing.

Implementations

impl MemoryGrant

pub fn size(&self) -> usize

Returns the size of this grant in bytes.

pub fn region(&self) -> MemoryRegion

Returns the memory region of this grant.

pub fn resize(&mut self, new_size: usize) -> bool

Attempts to resize the grant.

Returns true if the resize succeeded, false if more memory could not be allocated.

pub fn split(&mut self, amount: usize) -> Option<MemoryGrant>

Splits off a portion of this grant into a new grant.

Returns None if the requested amount exceeds the current size.

pub fn merge(&mut self, other: MemoryGrant)

Merges another grant into this one.

Both grants must be for the same region.

Panics

Panics if the grants are for different regions.

pub fn consume(self) -> usize

Consumes this grant without releasing memory.

Use this to transfer ownership of the memory to another owner. The caller is responsible for eventually releasing the memory.

pub fn is_consumed(&self) -> bool

Returns whether this grant has been consumed.

pub fn is_empty(&self) -> bool

Returns whether this grant is empty (size == 0).

Trait Implementations

impl Debug for MemoryGrant

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

Formats the value using the given formatter.

impl Drop for MemoryGrant

fn drop(&mut self)

Executes the destructor for this type.