Enum Capacity 

pub enum Capacity {
    MinSamples(NonZeroUsize),
}

Capacity bounds of a [RingBuffer].

Because buffers may be compressed, capacity is expressed in terms of bounds rather than exact quantities.

Variants

MinSamples(NonZeroUsize)

A lower bound on the number of samples that a buffer stores in memory.

Given a bound n, a buffer allocates enough memory for at least n samples, but may store more.

Implementations

impl Capacity

pub fn from_min_samples(n: usize) -> Self

Constructs a minimum samples capacity, clamping to [1, usize::MAX].

Trait Implementations

impl Clone for Capacity

fn clone(&self) -> Capacity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Capacity

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

Formats the value using the given formatter.

impl Display for Capacity

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

Formats the value using the given formatter.

impl Hash for Capacity

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Capacity

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

impl Eq for Capacity

impl StructuralPartialEq for Capacity