Enum IpEcn 

#[repr(u8)]
pub enum IpEcn {
    NotEct = 0,
    Ect1 = 1,
    Ect0 = 2,
    CongestionExperienced = 3,
}

Code points for “Explicit Congestion Notification” (ECN) present in the crate::Ipv4Header and crate::Ipv6Header.

Code points are defined in RFC-3168

For reasoning to why there are two code points with the exact same meaning, see RFC-3168 Section 20.2

Variants

NotEct = 0

End node is not an ECN capable transport.

Ect1 = 1

End node is an ECN capable transport (experimental).

Ect0 = 2

End node is an ECN capable transport.

CongestionExperienced = 3

Congestion is experienced by the router.

Implementations

impl IpEcn

pub const ZERO: IpEcn = IpEcn::NotEct

IpEcn with value 0.

pub const ONE: IpEcn = IpEcn::Ect1

IpEcn with value 1.

pub const TWO: IpEcn = IpEcn::Ect0

IpEcn with value 2.

pub const THREE: IpEcn = IpEcn::CongestionExperienced

IpEcn with value 3.

pub const MAX_U8: u8 = 3u8

Maximum value of an IPv4 or IPv6 header ECN.

pub const TRHEE: IpEcn = IpEcn::THREE

👎Deprecated since 0.18.0: Please use IpEcn::THREE instead.

Deprecated, use crate::IpEcn::THREE instead.

pub const fn try_new(value: u8) -> Result<IpEcn, ValueTooBigError<u8>>

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

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

use etherparse::IpEcn;

let ecn = IpEcn::try_new(2).unwrap();
assert_eq!(ecn.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!(
    IpEcn::try_new(IpEcn::MAX_U8 + 1),
    Err(ValueTooBigError{
        actual: IpEcn::MAX_U8 + 1,
        max_allowed: IpEcn::MAX_U8,
        value_type: ValueType::IpEcn,
    })
);

pub const unsafe fn new_unchecked(value: u8) -> IpEcn

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

Safety

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

pub const fn value(self) -> u8

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

Trait Implementations

impl Clone for IpEcn

fn clone(&self) -> IpEcn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IpEcn

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

Formats the value using the given formatter.

impl Default for IpEcn

fn default() -> Self

Returns the “default value” for a type.

impl Display for IpEcn

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

Formats the value using the given formatter.

impl From<IpEcn> for u8

fn from(value: IpEcn) -> Self

Converts to this type from the input type.

impl Hash for IpEcn

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 IpEcn

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

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

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

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 IpEcn

impl Eq for IpEcn

impl StructuralPartialEq for IpEcn