Struct MacsecShortLen

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

6 bit unsigned integer containing the “MACsec short length”. (present in the crate::MacsecHeader).

Implementations

impl MacsecShortLen

pub const ZERO: MacsecShortLen

MacsecShortLen with value 0.

pub const MAX_U8: u8 = 63u8

Maximum value of a “MACsec short length” as a u8.

pub const MAX_USIZE: usize = 63usize

Maximum value of a “MACsec short length” as a usize.

pub const fn try_from_u8( value: u8, ) -> Result<MacsecShortLen, ValueTooBigError<u8>>

Tries to create an MacsecShortLen and checks that the passed value is smaller or equal than MacsecShortLen::MAX_U8 (6 bit unsigned integer).

In case the passed value is bigger then what can be represented in an 6 bit integer an error is returned. Otherwise an Ok containing the MacsecShortLen.

use etherparse::MacsecShortLen;

let an = MacsecShortLen::try_from_u8(2).unwrap();
assert_eq!(an.value(), 2);

// if a number that can not be represented in an 2 bit integer
// gets passed in an error is returned
use etherparse::err::{ValueTooBigError, ValueType};
assert_eq!(
    MacsecShortLen::try_from_u8(MacsecShortLen::MAX_U8 + 1),
    Err(ValueTooBigError{
        actual: MacsecShortLen::MAX_U8 + 1,
        max_allowed: MacsecShortLen::MAX_U8,
        value_type: ValueType::MacsecShortLen,
    })
);

pub const unsafe fn from_u8_unchecked(value: u8) -> MacsecShortLen

Creates an MacsecShortLen without checking that the value is smaller or equal than MacsecShortLen::MAX_U8 (6 bit unsigned integer). The caller must guarantee that value <= MacsecShortLen::MAX_U8.

Safety

value must be smaller or equal than MacsecShortLen::MAX_U8 otherwise the behavior of functions or data structures relying on this pre-requirement is undefined.

pub fn from_len(len: usize) -> MacsecShortLen

Creates an MacsecShortLen from a length and automatically defaults to zero if too big. This mirrors the expected behavior of the short_len field in the crate::MacsecHeader.

Example

use etherparse::MacsecShortLen;

// if the length is smaller than 64.
let a = MacsecShortLen::from_len(34);
assert_eq!(34, a.value());

// if the length is greater than 64 [`MacsecShortLen::MAX_U8`]
// zero is returned
let b = MacsecShortLen::from_len(65);
assert_eq!(0, b.value());

pub const fn value(self) -> u8

Returns the underlying unsigned 6 bit value as an u8 value.

Trait Implementations

impl Clone for MacsecShortLen

fn clone(&self) -> MacsecShortLen

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MacsecShortLen

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

Formats the value using the given formatter.

impl Default for MacsecShortLen

fn default() -> MacsecShortLen

Returns the “default value” for a type.

impl Display for MacsecShortLen

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

Formats the value using the given formatter.

impl From<MacsecShortLen> for u8

fn from(value: MacsecShortLen) -> Self

Converts to this type from the input type.

impl Hash for MacsecShortLen

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 MacsecShortLen

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

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

fn partial_cmp(&self, other: &MacsecShortLen) -> 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 TryFrom<u8> for MacsecShortLen

type Error = ValueTooBigError<u8>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for MacsecShortLen

impl Eq for MacsecShortLen

impl StructuralPartialEq for MacsecShortLen