Enum BatchMode 

pub enum BatchMode {
    Fixed(NonZeroUsize),
    Adaptive(NonZeroUsize, Duration),
    Timed {
        max_size: NonZeroUsize,
        interval: Duration,
    },
    Single,
}

Which policy to use for batching the messages before sending them.

Avoid constructing directly this enumeration, please use BatchMode::fixed() and BatchMode::adaptive() constructors.

The default batch mode is Adaptive(1024, 50ms), meaning that a batch is flushed either when it has at least 1024 messages, or no message has been received in the last 50ms.

Variants

Fixed(NonZeroUsize)

A batch is flushed only when the specified number of messages is present.

Adaptive(NonZeroUsize, Duration)

A batch is flushed only when the specified number of messages is present or a timeout expires. NOTE: The timer is checked only when a new message arrives, for background timers with a small execution overhead use BatchMode::Timed

Timed

A batch is flushed only when the specified number of messages is present or a timeout expires. The timer is checked in the background. Using background timers may incud in a very small perfomance overhead when compared to Fixed or Adaptive batching

Fields

max_size: NonZeroUsize

interval: Duration

Single

Send a size 1 batch for each element

Implementations

impl BatchMode

pub fn max_size(&self) -> usize

pub fn interval(&self) -> Option<Duration>

impl BatchMode

pub fn fixed(size: usize) -> BatchMode

Construct a new BatchMode::Fixed with the given positive batch size.

pub fn adaptive(size: usize, max_delay: Duration) -> BatchMode

Construct a new BatchMode::Adaptive with the given positive batch size and maximum delay.

pub fn timed(size: usize, interval: Duration) -> BatchMode

Construct a new BatchMode::Adaptive with the given positive batch size and maximum delay.

pub fn single() -> BatchMode

Construct a new BatchMode::Single.

pub fn max_delay(&self) -> Option<Duration>

Trait Implementations

impl Clone for BatchMode

fn clone(&self) -> BatchMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchMode

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

Formats the value using the given formatter.

impl Default for BatchMode

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for BatchMode

fn eq(&self, other: &BatchMode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BatchMode

impl Eq for BatchMode

impl StructuralPartialEq for BatchMode