Struct valence_protocol::Bounded

pub struct Bounded<T, const MAX: usize>(pub T);

A newtype wrapper for T which modifies the Encode and Decode impls to be bounded by some upper limit MAX. Implementations are expected to error eagerly if the limit is exceeded.

What exactly MAX represents depends on the type T. Here are some instances:

• arrays/slices: The maximum number of elements.
• strings: The maximum number of utf16 code units.
• RawBytes: The maximum number of bytes.

Tuple Fields

0: T

Implementations

impl<T, const MAX: usize> Bounded<T, MAX>

pub fn map<F: FnOnce(T) -> U, U>(self, f: F) -> Bounded<U, MAX>

pub fn map_into<U: From<T>>(self) -> Bounded<U, MAX>

Trait Implementations

impl<T, const MAX: usize> AsRef<T> for Bounded<T, MAX>

fn as_ref(&self) -> &T

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

impl<T, const MAX: usize> Borrow<T> for Bounded<T, MAX>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: Clone, const MAX: usize> Clone for Bounded<T, MAX>

fn clone(&self) -> Bounded<T, MAX>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const MAX: usize> Debug for Bounded<T, MAX>

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

Formats the value using the given formatter.

impl<const MAX_CHARS: usize> Decode<'_> for Bounded<Box<str>, MAX_CHARS>

fn decode(r: &mut &[u8]) -> Result<Self>

Reads this object from the provided byte slice.

impl<const MAX_CHARS: usize> Decode<'_> for Bounded<String, MAX_CHARS>

fn decode(r: &mut &[u8]) -> Result<Self>

Reads this object from the provided byte slice.

impl<'a, const MAX_LEN: usize> Decode<'a> for Bounded<&'a [u8], MAX_LEN>

fn decode(r: &mut &'a [u8]) -> Result<Self>

Reads this object from the provided byte slice.

impl<'a, const MAX_CHARS: usize> Decode<'a> for Bounded<&'a str, MAX_CHARS>

fn decode(r: &mut &'a [u8]) -> Result<Self>

Reads this object from the provided byte slice.

impl<'a, T: Decode<'a>, const MAX_LEN: usize> Decode<'a> for Bounded<Box<[T]>, MAX_LEN>

fn decode(r: &mut &'a [u8]) -> Result<Self>

Reads this object from the provided byte slice.

impl<'a, const MAX_BYTES: usize> Decode<'a> for Bounded<RawBytes<'a>, MAX_BYTES>

Raises a decoding error if the remainder of the input is larger than MAX_BYTES.

fn decode(r: &mut &'a [u8]) -> Result<Self>

Reads this object from the provided byte slice.

impl<'a, T: Decode<'a>, const MAX_LEN: usize> Decode<'a> for Bounded<Vec<T>, MAX_LEN>

fn decode(r: &mut &'a [u8]) -> Result<Self>

Reads this object from the provided byte slice.

impl<T: Default, const MAX: usize> Default for Bounded<T, MAX>

fn default() -> Bounded<T, MAX>

Returns the “default value” for a type.

impl<T, const MAX: usize> Deref for Bounded<T, MAX>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, const MAX: usize> DerefMut for Bounded<T, MAX>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Display, const MAX: usize> Display for Bounded<T, MAX>

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

Formats the value using the given formatter.

impl<T: Encode, const MAX_LEN: usize> Encode for Bounded<&[T], MAX_LEN>

fn encode(&self, w: impl Write) -> Result<()>

Writes this object to the provided writer.

fn encode_slice(slice: &[Self], w: impl Write) -> Result<()>

where Self: Sized,

Like Encode::encode, except that a whole slice of values is encoded.

impl<const MAX_CHARS: usize> Encode for Bounded<&str, MAX_CHARS>

fn encode(&self, w: impl Write) -> Result<()>

Writes this object to the provided writer.

fn encode_slice(slice: &[Self], w: impl Write) -> Result<()>

where Self: Sized,

Like Encode::encode, except that a whole slice of values is encoded.

impl<const MAX_BYTES: usize> Encode for Bounded<RawBytes<'_>, MAX_BYTES>

Raises an encoding error if the inner slice is longer than MAX_BYTES.

fn encode(&self, w: impl Write) -> Result<()>

Writes this object to the provided writer.

fn encode_slice(slice: &[Self], w: impl Write) -> Result<()>

where Self: Sized,

Like Encode::encode, except that a whole slice of values is encoded.

impl<const MAX_CHARS: usize> Encode for Bounded<String, MAX_CHARS>

fn encode(&self, w: impl Write) -> Result<()>

Writes this object to the provided writer.

fn encode_slice(slice: &[Self], w: impl Write) -> Result<()>

where Self: Sized,

Like Encode::encode, except that a whole slice of values is encoded.

impl<T, const MAX: usize> From<T> for Bounded<T, MAX>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash, const MAX: usize> Hash for Bounded<T, MAX>

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<T: Ord, const MAX: usize> Ord for Bounded<T, MAX>

fn cmp(&self, other: &Bounded<T, MAX>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq, const MAX: usize> PartialEq for Bounded<T, MAX>

fn eq(&self, other: &Bounded<T, MAX>) -> 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<T: PartialOrd, const MAX: usize> PartialOrd for Bounded<T, MAX>

fn partial_cmp(&self, other: &Bounded<T, MAX>) -> 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<T: Copy, const MAX: usize> Copy for Bounded<T, MAX>

impl<T: Eq, const MAX: usize> Eq for Bounded<T, MAX>

impl<T, const MAX: usize> StructuralPartialEq for Bounded<T, MAX>