Struct Icmp

pub struct Icmp { /* private fields */ }

This attribute is used by servers to signal the reason a UDP packet was dropped.

Examples

let icmp_type = IcmpType::new(127).ok_or_else(|| "Invalid ICMP type")?;
let icmp_code = IcmpCode::new(511).ok_or_else(|| "Invalid ICMP code")?;
let attr = Icmp::new(icmp_type, icmp_code, [0x01, 0x02, 0x03, 0x04]);

assert_eq!(attr.icmp_type(), icmp_type);
assert_eq!(attr.icmp_code(), icmp_code);
assert_eq!(attr.error_data(), &[0x01, 0x02, 0x03, 0x04]);

Implementations

impl Icmp

pub fn new( icmp_type: IcmpType, icmp_code: IcmpCode, error_data: [u8; 4], ) -> Self

Creates a new Icmp attribute

pub fn icmp_type(&self) -> IcmpType

Returns the ICMP type.

pub fn icmp_code(&self) -> IcmpCode

Returns the error data.

pub fn error_data(&self) -> &[u8]

Returns the error data. This field size is 4 bytes long. If the ICMPv6 type is 2 (“Packet too big” message) or ICMPv4 type is 3 (Destination Unreachable) and Code is 4 (fragmentation needed and DF set), the Error Data field will be set to the Maximum Transmission Unit of the next-hop link (Section 3.2 of RFC4443 and Section 4 of RFC1191). For other ICMPv6 types and ICMPv4 types and codes, the Error Data field MUST be set to zero.

Trait Implementations

impl Clone for Icmp

fn clone(&self) -> Icmp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Icmp

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

Formats the value using the given formatter.

impl From<Icmp> for StunAttribute

fn from(value: Icmp) -> Self

Converts to this type from the input type.

impl PartialEq for Icmp

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

fn get_type() -> AttributeType

where Self: Sized,

Returns the STUN attribute type.

fn attribute_type(&self) -> AttributeType

Returns the STUN attribute type of this instance.

impl Eq for Icmp

impl StructuralPartialEq for Icmp