Trait datafusion::execution::memory_pool::MemoryPool

pub trait MemoryPool: Send + Sync + Debug {
    fn grow(&self, reservation: &MemoryReservation, additional: usize);
    fn shrink(&self, reservation: &MemoryReservation, shrink: usize);
    fn try_grow(
        &self,
        reservation: &MemoryReservation,
        additional: usize
    ) -> Result<()>;
    fn reserved(&self) -> usize;

    fn register(&self, _consumer: &MemoryConsumer) { ... }
    fn unregister(&self, _consumer: &MemoryConsumer) { ... }
}

The pool of memory on which MemoryReservation record their memory reservations

Required Methods

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

Infallibly grow the provided reservation by additional bytes

This must always succeed

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

Infallibly shrink the provided reservation by shrink bytes

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

Attempt to grow the provided reservation by additional bytes

On error the allocation will not be increased in size

fn reserved(&self) -> usize

Return the total amount of memory reserved

Provided Methods

fn register(&self, _consumer: &MemoryConsumer)

Registers a new MemoryConsumer

Note: Subsequent calls to Self::grow must be made to reserve memory

fn unregister(&self, _consumer: &MemoryConsumer)

Records the destruction of a MemoryReservation with MemoryConsumer

Note: Prior calls to Self::shrink must be made to free any reserved memory

Implementors

impl MemoryPool for FairSpillPool

impl MemoryPool for GreedyMemoryPool

impl MemoryPool for UnboundedMemoryPool