Struct BufferCapacity 

pub struct BufferCapacity { /* private fields */ }

Wrapper type used to define buffer capacity.

Capacity must be greater than 0 and less or equal usize::MAX / 2.

Examples

let capacity = BufferCapacity::try_from(16).unwrap();
assert_eq!(16, *capacity.as_ref());

let result = BufferCapacity::try_from(0);
assert!(result.is_err());

let result = BufferCapacity::try_from(usize::MAX / 2 + 1);
assert!(result.is_err());

Trait Implementations

impl AsRef<usize> for BufferCapacity

fn as_ref(&self) -> &usize

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for BufferCapacity

fn clone(&self) -> BufferCapacity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BufferCapacity

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

Formats the value using the given formatter.

impl Default for BufferCapacity

Default capacity value is 16.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BufferCapacity

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for BufferCapacity

fn cmp(&self, other: &BufferCapacity) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BufferCapacity

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

fn partial_cmp(&self, other: &BufferCapacity) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for BufferCapacity

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<usize> for BufferCapacity

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for BufferCapacity

impl Eq for BufferCapacity

impl StructuralPartialEq for BufferCapacity