Trait datafusion::execution::memory_manager::MemoryConsumer

pub trait MemoryConsumer: Send + Sync {
    fn name(&self) -> String;
    fn id(&self) -> &MemoryConsumerId;
    fn memory_manager(&self) -> Arc<MemoryManager>;
    fn type_(&self) -> &ConsumerType;
    fn spill<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
    fn mem_used(&self) -> usize;

    fn partition_id(&self) -> usize { ... }
    fn try_grow<'life0, 'async_trait>(
        &'life0 self,
        required: usize
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait,
    { ... }
    fn grow(&self, required: usize) { ... }
    fn shrink(&self, freed: usize) { ... }
}

A memory consumer that either takes up memory (of type ConsumerType::Tracking) or grows/shrinks memory usage based on available memory (of type ConsumerType::Requesting).

Required Methods

fn name(&self) -> String

Display name of the consumer

fn id(&self) -> &MemoryConsumerId

Unique id of the consumer

fn memory_manager(&self) -> Arc<MemoryManager>

Ptr to MemoryManager

fn type_(&self) -> &ConsumerType

Type of the consumer

fn spill<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Spill in-memory buffers to disk, free memory, return the previous used

fn mem_used(&self) -> usize

Current memory used by this consumer

Provided Methods

fn partition_id(&self) -> usize

Partition that the consumer belongs to

fn try_grow<'life0, 'async_trait>(
    &'life0 self,
    required: usize
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Grow memory by required to buffer more data in memory, this may trigger spill before grow when the memory threshold is reached for this consumer.

fn grow(&self, required: usize)

Grow without spilling to the disk. It grows the memory directly so it should be only used when the consumer already allocated the memory and it is safe to grow without spilling.

fn shrink(&self, freed: usize)

Return freed memory to the memory manager, may wake up other requesters waiting for their minimum memory quota.

Trait Implementations

impl Debug for dyn MemoryConsumer

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

Formats the value using the given formatter.

impl Display for dyn MemoryConsumer

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

Formats the value using the given formatter.

Implementors