Struct BatchPolicy 

pub struct BatchPolicy { /* private fields */ }

Trigger configuration for a batching stage.

All configured triggers OR together: the batch is flushed as soon as any one of them is satisfied. At least one of max_items, max_bytes, or max_age must be set for the builder to accept the policy.

Example

use pipe_io::BatchPolicy;
let p = BatchPolicy::new().max_items(1_000);
assert_eq!(p.items_limit(), Some(1_000));

Implementations

impl BatchPolicy

pub const fn new() -> Self

Construct a new empty policy. At least one trigger must be set before the policy is used by the builder.

pub const fn max_items(self, n: usize) -> Self

Set the maximum number of items per batch.

pub const fn max_bytes(self, n: usize) -> Self

Set the maximum byte size per batch. Requires the item type to implement ByteSize.

pub const fn max_age(self, age: Duration) -> Self

Available on crate feature std only.

Set the maximum age of a batch (time between first push and flush). Requires the std feature.

pub const fn items_limit(&self) -> Option<usize>

Current items trigger.

pub const fn bytes_limit(&self) -> Option<usize>

Current byte trigger.

pub const fn age_limit(&self) -> Option<Duration>

Available on crate feature std only.

Current age trigger.

pub const fn has_trigger(&self) -> bool

True if at least one trigger is configured.

Trait Implementations

impl Clone for BatchPolicy

fn clone(&self) -> BatchPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchPolicy

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

Formats the value using the given formatter.

impl Default for BatchPolicy

fn default() -> BatchPolicy

Returns the “default value” for a type.

impl Copy for BatchPolicy