Struct datafusion::execution::memory_pool::MemoryConsumer

pub struct MemoryConsumer { /* private fields */ }

A memory consumer is a named allocation traced by a particular MemoryReservation in a MemoryPool. All allocations are registered to a particular MemoryConsumer;

For help with allocation accounting, see the proxy module.

Implementations

impl MemoryConsumer

pub fn new(name: impl Into<String>) -> MemoryConsumer

Create a new empty MemoryConsumer that can be grown using MemoryReservation

pub fn with_can_spill(self, can_spill: bool) -> MemoryConsumer

Set whether this allocation can be spilled to disk

pub fn can_spill(&self) -> bool

Returns true if this allocation can spill to disk

pub fn name(&self) -> &str

Returns the name associated with this allocation

pub fn register(self, pool: &Arc<dyn MemoryPool>) -> MemoryReservation

Registers this MemoryConsumer with the provided MemoryPool returning a MemoryReservation that can be used to grow or shrink the memory reservation

Trait Implementations

impl Debug for MemoryConsumer

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

Formats the value using the given formatter.