Struct MemoryTracker 

pub struct MemoryTracker { /* private fields */ }

Tracks estimated memory usage for a streaming operator.

Implementations

impl MemoryTracker

pub fn new(policy: MemoryPolicy) -> MemoryTracker

Create an empty tracker using policy.

pub fn used_bytes(&self) -> u64

Return the currently tracked byte count.

pub fn policy(&self) -> &MemoryPolicy

Return the memory policy used by this tracker.

pub fn over_limit(&self) -> bool

Return whether the tracked byte count exceeds the policy limit.

pub fn reset(&mut self)

Reset tracked memory to zero after a successful spill or drain.

pub fn add_bytes(&mut self, bytes: u64) -> Result<(), Error>

Add a raw byte estimate and enforce the policy.

pub fn add_row<T>(&mut self, values: &[T]) -> Result<(), Error>

where T: ByteSized,

Add a row-like slice of byte-sized values.

pub fn add_values<T>(&mut self, values: &[T]) -> Result<(), Error>

where T: ByteSized,

Add a slice of byte-sized values.

pub fn add_value<T>(&mut self, value: &T) -> Result<(), Error>

where T: ByteSized,

Add one byte-sized value.

Trait Implementations

impl Clone for MemoryTracker

fn clone(&self) -> MemoryTracker

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MemoryTracker

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

Formats the value using the given formatter.