Struct MaxFrameSize 

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

The largest frame a decoder will accept, in bytes, excluding the terminator.

A caller sets this. There is no constant a decoder falls back to, because a ceiling nobody chose is a ceiling nobody has checked against the largest message the application actually sends.

The inner type is NonZeroU32: a limit of zero would accept no frame at all, including the empty one, which is a configuration mistake rather than a policy, and refusing it at construction is the last point at which the caller can still see what they did.

Examples

use protocol_droid::domain::{MaxFrameSize, MaxFrameSizeError};

let limit = MaxFrameSize::new(8 * 1024 * 1024)?;
assert_eq!(limit.bytes(), 8 * 1024 * 1024);

assert_eq!(MaxFrameSize::new(0), Err(MaxFrameSizeError::Zero));
assert!(MaxFrameSize::new(1).is_ok());

Implementations

impl MaxFrameSize

pub const DEFAULT: Self

A starting point, for a caller who wants one and will still name it.

Four mebibytes comfortably holds a tools/list of a large catalogue while still bounding a hostile peer.

pub const fn new(bytes: u32) -> Result<Self, MaxFrameSizeError>

Builds a limit.

Errors

MaxFrameSizeError::Zero when bytes is zero. See the type’s docs for why that is refused rather than accepted.

pub const fn bytes(self) -> u32

The limit, in bytes.

Trait Implementations

impl Clone for MaxFrameSize

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MaxFrameSize

impl Debug for MaxFrameSize

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

Formats the value using the given formatter.

impl Display for MaxFrameSize

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

Formats the value using the given formatter.

impl Eq for MaxFrameSize

impl Hash for MaxFrameSize

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 Ord for MaxFrameSize

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for MaxFrameSize

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MaxFrameSize

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for MaxFrameSize