Struct etherparse::Ipv6RawExtHeader

pub struct Ipv6RawExtHeader {
    pub next_header: IpNumber,
    /* private fields */
}

Raw IPv6 extension header (undecoded payload).

IPv6 extension header with only minimal data interpretation. NOTE only ipv6 header extensions with the first two bytes representing the next header and the header length in 8-octets (- 8 octets) can be represented with this struct. This excludes the “Authentication Header” (AH) and “Encapsulating Security Payload” (ESP).

The following headers can be represented in a Ipv6RawExtHeader:

• Hop by Hop
• Destination Options
• Routing
• Mobility
• Host Identity Protocol
• Shim6 Protocol

Fields

next_header: IpNumber

IP protocol number specifying the next header or transport layer protocol.

See IpNumber or ip_number for a definition of the known values.

Implementations

impl Ipv6RawExtHeader

pub const MIN_LEN: usize = 8usize

Minimum length of an raw IPv6 extension header in bytes/octets.

pub const MAX_LEN: usize = 2_048usize

Maximum length of an raw IPv6 extension header in bytes/octets.

This number is calculated by multiplying the maximum “hdr ext len” (0xff) with 8 and adding 8. As RFC8200 states that “hdr ext len” is defined as “8-bit unsigned integer. Length of the Hop-by-Hop Options header in 8-octet units, not including the first 8 octets.”

pub const MIN_PAYLOAD_LEN: usize = 6usize

Minimum length of a Ipv6RawExtHeader payload

pub const MAX_PAYLOAD_LEN: usize = 2_046usize

Maximum length of a Ipv6RawExtHeader the payload

pub fn header_type_supported(next_header: IpNumber) -> bool

Returns true if the given header type ip number can be represented in an Ipv6ExtensionHeader.

pub fn new_raw( next_header: IpNumber, payload: &[u8] ) -> Result<Ipv6RawExtHeader, ExtPayloadLenError>

Creates an generic IPv6 extension header with the given data.

Arguments

• next_header - type of content after this header (protocol number)
• payload - slice containing the data of the header. This must NOT contain the next header and extended header length fields of the header.

Note that payload must have at least the length of 6 bytes and only supports length increases in steps of 8. This measn that the following expression must be true (payload.len() + 2) % 8 == 0. The maximum length of the payload is 2046 bytes (Ipv6RawExtHeader::MAX_PAYLOAD_LEN).

If a payload with a non supported length is provided a crate::err::ipv6_exts::ExtPayloadLenError is returned.

pub fn from_slice(slice: &[u8]) -> Result<(Ipv6RawExtHeader, &[u8]), LenError>

Read an Ipv6ExtensionHeader from a slice and return the header & unused parts of the slice.

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

Return a slice containing the current payload. This does NOT contain the next_header and header_length fields. But everything after these two fields.

pub fn set_payload(&mut self, payload: &[u8]) -> Result<(), ExtPayloadLenError>

Sets the payload (content of the header after the next_header & header_length fields).

Note that payload must have at least the length of 6 bytes and only supports length increases in steps of 8. This measn that the following expression must be true (payload.len() + 2) % 8 == 0. The maximum length of the payload is 2046 bytes (crate::Ipv6RawExtHeader::MAX_PAYLOAD_LEN).

If a payload with a non supported length is provided a crate::err::ipv6_exts::ExtPayloadLenError is returned and the payload of the header is not changed.

pub fn read<T: Read + Seek + Sized>( reader: &mut T ) -> Result<Ipv6RawExtHeader, Error>

Available on crate feature std only.

Read an fragment header from the current reader position.

pub fn read_limited<T: Read + Seek + Sized>( reader: &mut LimitedReader<T> ) -> Result<Ipv6RawExtHeader, LimitedReadError>

Available on crate feature std only.

Read an fragment header from the current limited reader position.

pub fn write<W: Write + Sized>(&self, writer: &mut W) -> Result<(), Error>

Available on crate feature std only.

Writes a given IPv6 extension header to the current position.

pub fn to_bytes(&self) -> ArrayVec<u8, { Ipv6RawExtHeader::MAX_LEN }>

Returns the serialized header.

pub fn header_len(&self) -> usize

Length of the header in bytes.

Trait Implementations

impl Clone for Ipv6RawExtHeader

fn clone(&self) -> Ipv6RawExtHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ipv6RawExtHeader

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

Formats the value using the given formatter.

impl Default for Ipv6RawExtHeader

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Ipv6RawExtHeader

fn eq(&self, other: &Self) -> 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 Eq for Ipv6RawExtHeader