Struct etherparse::VlanId

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

12 bit unsigned integer containing the “VLAN identifier” (present in the crate::SingleVlanHeader).

Implementations

impl VlanId

pub const ZERO: VlanId = _

VlanId with value 0.

pub const MAX_U16: u16 = 4_095u16

Maximum value of an VLAN id.

pub const fn try_new(value: u16) -> Result<VlanId, ValueTooBigError<u16>>

Tries to create an VlanId and checks that the passed value is smaller or equal than VlanId::MAX_U16 (12 bit unsigned integer).

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

use etherparse::VlanId;

let vlanid = VlanId::try_new(2).unwrap();
assert_eq!(vlanid.value(), 2);

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

pub const unsafe fn new_unchecked(value: u16) -> VlanId

Creates an VlanId WITHOUT checking that the value is smaller or equal than VlanId::MAX_U16 (12 bit unsigned integer). The caller must guarantee that value <= VlanId::MAX_U16.

Safety

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

pub const fn value(self) -> u16

Returns the underlying unsigned 12 bit value as an u16 value.

Trait Implementations

impl Clone for VlanId

fn clone(&self) -> VlanId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VlanId

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

Formats the value using the given formatter.

impl Default for VlanId

fn default() -> VlanId

Returns the “default value” for a type.

impl Display for VlanId

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

Formats the value using the given formatter.

impl From<VlanId> for u16

fn from(value: VlanId) -> Self

Converts to this type from the input type.

impl Hash for VlanId

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 VlanId

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

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for VlanId

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

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

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

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

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

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

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

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

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

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

impl TryFrom<u16> for VlanId

type Error = ValueTooBigError<u16>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for VlanId

impl Eq for VlanId

impl StructuralPartialEq for VlanId