Struct datafusion_execution::memory_pool::TrackConsumersPool

pub struct TrackConsumersPool<I> { /* private fields */ }

A MemoryPool that tracks the consumers that have reserved memory within the inner memory pool.

By tracking memory reservations more carefully this pool can provide better error messages on the largest memory users

Tracking is per hashed MemoryConsumer, not per MemoryReservation. The same consumer can have multiple reservations.

Implementations

impl<I: MemoryPool> TrackConsumersPool<I>

pub fn new(inner: I, top: NonZeroUsize) -> Self

Creates a new TrackConsumersPool.

The top determines how many Top K MemoryConsumers to include in the reported DataFusionError::ResourcesExhausted.

pub fn report_top(&self, top: usize) -> String

The top consumers in a report string.

Trait Implementations

impl<I: Debug> Debug for TrackConsumersPool<I>

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

Formats the value using the given formatter.

impl<I: MemoryPool> MemoryPool for TrackConsumersPool<I>

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 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

fn reserved(&self) -> usize

Return the total amount of memory reserved