Struct ScopedMemoryPool 

pub struct ScopedMemoryPool { /* private fields */ }

A [MemoryPool] that forwards every call to inner, while separately tracking the current and peak (high-water mark) reservation grown through this instance alone.

Implementations

impl ScopedMemoryPool

pub fn new(inner: Arc<dyn MemoryPool>) -> ScopedMemoryPool

Wraps inner, starting both counters at zero.

pub fn peak(&self) -> usize

Monotonic high-water mark of tracked reservation for this query, in bytes.

pub fn current(&self) -> usize

Currently outstanding tracked reservation, in bytes; 0 at quiescence.

Trait Implementations

impl Debug for ScopedMemoryPool

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

Formats the value using the given formatter.

impl Display for ScopedMemoryPool

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

Formats the value using the given formatter.

impl MemoryPool for ScopedMemoryPool

fn name(&self) -> &str

Return pool name

fn register(&self, consumer: &MemoryConsumer)

Registers a new [MemoryConsumer]

fn unregister(&self, consumer: &MemoryConsumer)

Records the destruction of a [MemoryReservation] with [MemoryConsumer]

fn grow(&self, reservation: &MemoryReservation, additional: usize)

Infallibly grow the provided reservation by additional bytes

fn try_grow( &self, reservation: &MemoryReservation, additional: usize, ) -> Result<(), DataFusionError>

Attempt to grow the provided reservation by additional bytes

fn shrink(&self, reservation: &MemoryReservation, shrink: usize)

Infallibly shrink the provided reservation by shrink bytes

fn reserved(&self) -> usize

Return the total amount of memory reserved

fn memory_limit(&self) -> MemoryLimit

Return the memory limit of the pool