Struct BatchSize

pub struct BatchSize(/* private fields */);

A type representing an operation count in a queue (e.g. the number of packets allowed to be dequeued in a single operation).

BatchSize is always capped at the maximum supported batch size for the queue and defaults to that value.

Implementations

impl BatchSize

pub const MAX: usize = 100usize

The maximum usize value that BatchSize can assume.

Restricting the amount of work that can be done at once in a queue serves two purposes:

• It sets an upper bound on the amount of work that can be done before yielding the thread to other work.
• It sets an upper bound of memory consumption set aside for dequeueing, because dequeueing takes frames from the queue and “stages” them in a separate context.

pub fn new_saturating(v: usize) -> BatchSize

Creates a new BatchSize with a value of v saturating to BatchSize::MAX.

Trait Implementations

impl Clone for BatchSize

fn clone(&self) -> BatchSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BatchSize

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

Formats the value using the given formatter.

impl Default for BatchSize

fn default() -> BatchSize

Returns the “default value” for a type.

impl PartialEq for BatchSize

fn eq(&self, other: &BatchSize) -> 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 BatchSize

impl Eq for BatchSize

impl StructuralPartialEq for BatchSize