Struct MemoryPolicy 

pub struct MemoryPolicy { /* private fields */ }

Memory accounting policy used by streaming SQL operators.

Implementations

impl MemoryPolicy

pub fn new(limit_bytes: Option<u64>, spill_policy: SpillPolicy) -> MemoryPolicy

Create a memory policy with an optional byte limit and spill behavior.

pub fn limit_bytes(&self) -> Option<u64>

Return the configured byte limit, if any.

pub fn spill_policy(&self) -> &SpillPolicy

Return the configured spill behavior.

pub fn with_metrics(self, metrics: Arc<dyn SpillMetricsSink>) -> MemoryPolicy

Attach a metrics sink to this policy.

pub fn spill_directory(&self) -> Option<&Path>

Return the spill directory when disk spilling is enabled.

pub fn record_spill(&self, bytes: u64, files: u64)

Record a spill through the configured metrics sink, when present.

pub fn over_limit(&self, used_bytes: u64) -> bool

Return whether used_bytes exceeds the configured limit.

pub fn enforce(&self, used_bytes: u64) -> Result<(), Error>

Enforce this memory policy for used_bytes.

Trait Implementations

impl Clone for MemoryPolicy

fn clone(&self) -> MemoryPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryPolicy

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

Formats the value using the given formatter.