Struct simple_tlv::Length

pub struct Length(_);

SIMPLE-TLV-encoded length.

By definition, in the range 0..=65535

The length field consists of one or three consecutive bytes.

• If the first byte is not 0xFF, then the length field consists of a single byte encoding a number from zero to 254.
• If the first byte is 0xFF, then the length field consists of the subsequent two bytes interpreted as big-endian integer, with any value from zero to 65,535.

Implementations

impl Length

pub const fn zero() -> Self

Return a length of 0.

pub const fn max() -> usize

Get the maximum length supported by SIMPLE-TLV: 65,535.

pub fn to_usize(self) -> usize

Convert length to usize.

Trait Implementations

impl Add<Length> for Length

type Output = Result<Self>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Result<Self>

Performs the + operation.

impl Add<Length> for Result<Length>

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Length) -> Self

Performs the + operation.

impl Add<u16> for Length

type Output = Result<Self>

The resulting type after applying the + operator.

fn add(self, other: u16) -> Result<Self>

Performs the + operation.

impl Add<u8> for Length

type Output = Result<Self>

The resulting type after applying the + operator.

fn add(self, other: u8) -> Result<Self>

Performs the + operation.

impl Add<usize> for Length

type Output = Result<Self>

The resulting type after applying the + operator.

fn add(self, other: usize) -> Result<Self>

Performs the + operation.

impl Clone for Length

fn clone(&self) -> Length

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Length

impl Debug for Length

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

Formats the value using the given formatter.

impl Decodable<'_> for Length

fn decode(decoder: &mut Decoder<'_>) -> Result<Length>

Attempt to decode this message using the provided decoder.

fn from_bytes(bytes: &'a [u8]) -> Result<Self>

Parse Self from the provided byte slice.

impl Default for Length

fn default() -> Length

Returns the "default value" for a type.

impl Display for Length

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

Formats the value using the given formatter.

impl Encodable for Length

fn encoded_length(&self) -> Result<Length>

Compute the length of this value in bytes when encoded as SIMPLE-TLV

fn encode(&self, encoder: &mut Encoder<'_>) -> Result<()>

Encode this value as SIMPLE-TLV using the provided Encoder.

fn encode_to_slice<'a>(&self, buf: &'a mut [u8]) -> Result<&'a [u8]>

Encode this value to the provided byte slice, returning a sub-slice containing the encoded message.

impl Eq for Length

impl From<Length> for u16

fn from(len: Length) -> u16

Performs the conversion.

impl From<Length> for usize

fn from(len: Length) -> usize

Performs the conversion.

impl From<u16> for Length

fn from(len: u16) -> Length

Performs the conversion.

impl From<u8> for Length

fn from(len: u8) -> Length

Performs the conversion.

impl Ord for Length

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Length> for Length

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Length> for Length

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for Length

impl StructuralPartialEq for Length

impl<'a> TryFrom<&'a [&'a (dyn Encodable + 'a)]> for Length

Calculate the sum of the encoded lengths of the encodables.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(encodables: &[&dyn Encodable]) -> Result<Length>

Performs the conversion.

impl TryFrom<usize> for Length

type Error = Error

The type returned in the event of a conversion error.

fn try_from(len: usize) -> Result<Length>

Performs the conversion.