Struct MemoryContext 

pub struct MemoryContext {
    inner: Option<Arc<MemoryContextInner>>,
}

Fields

inner: Option<Arc<MemoryContextInner>>

Add None op mem context, so that we don’t need to return Option in BatchTaskContext. This helps with later Allocator implementation.

Implementations

impl MemoryContext

pub fn new(parent: Option<MemoryContext>, counter: impl MemCounter) -> Self

pub fn new_with_mem_limit( parent: Option<MemoryContext>, counter: impl MemCounter, mem_limit: u64, ) -> Self

pub fn none() -> Self

Creates a noop memory context.

pub fn root(counter: impl MemCounter, mem_limit: u64) -> Self

pub fn for_spill_test() -> Self

pub fn add(&self, bytes: i64) -> bool

Attempts to charge bytes against this context and its ancestors. Returns false, without updating counters, if a positive charge would exceed a limit. Negative values release previously recorded usage, even while over budget. Use Self::add_unchecked to record allocations that proceed regardless of the budget.

pub fn add_unchecked(&self, bytes: i64)

Records a memory-usage change without enforcing this context’s or its ancestors’ limits.

Use this for allocations that have already succeeded and their corresponding releases. Every recorded allocation must have a matching release. This does not allocate/free memory or clamp the counter; callers remain responsible for balanced accounting. For admission control, use Self::add instead. To inspect the resulting budget state, use Self::check_memory_usage.

pub fn get_bytes_used(&self) -> i64

pub fn mem_limit(&self) -> u64

pub fn check_memory_usage(&self) -> bool

Check if the memory usage exceeds the limit. Returns false if the memory usage exceeds the limit.

pub fn global_allocator(&self) -> MonitoredGlobalAlloc

Creates a new global allocator that reports memory usage to this context.

Trait Implementations

impl Clone for MemoryContext

fn clone(&self) -> MemoryContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.