Struct smoltcp::wire::Ipv6RoutingHeader

pub struct Ipv6RoutingHeader<T: AsRef<[u8]>> { /* private fields */ }

A read/write wrapper around an IPv6 Routing Header buffer.

Implementations

impl<T: AsRef<[u8]>> Header<T>

Core getter methods relevant to any routing type.

pub fn new(buffer: T) -> Header<T>

Create a raw octet buffer with an IPv6 Routing Header structure.

pub fn new_checked(buffer: T) -> Result<Header<T>>

Shorthand for a combination of new_unchecked and check_len.

pub fn check_len(&self) -> Result<()>

Ensure that no accessor method will panic if called. Returns Err(Error::Truncated) if the buffer is too short.

The result of this check is invalidated by calling set_header_len.

pub fn into_inner(self) -> T

Consume the header, returning the underlying buffer.

pub fn next_header(&self) -> Protocol

Return the next header field.

pub fn header_len(&self) -> u8

Return the header length field. Length of the Routing header in 8-octet units, not including the first 8 octets.

pub fn routing_type(&self) -> Type

Return the routing type field.

pub fn segments_left(&self) -> u8

Return the segments left field.

impl<T: AsRef<[u8]>> Header<T>

Getter methods for the Type 2 Routing Header routing type.

pub fn home_address(&self) -> Address

Return the IPv6 Home Address

Panics

This function may panic if this header is not the Type2 Routing Header routing type.

impl<T: AsRef<[u8]>> Header<T>

Getter methods for the RPL Source Routing Header routing type.

pub fn cmpr_i(&self) -> u8

Return the number of prefix octects elided from addresses[1..n-1].

Panics

This function may panic if this header is not the RPL Source Routing Header routing type.

pub fn cmpr_e(&self) -> u8

Return the number of prefix octects elided from the last address (addresses[n]).

Panics

This function may panic if this header is not the RPL Source Routing Header routing type.

pub fn pad(&self) -> u8

Return the number of octects used for padding after addresses[n].

Panics

This function may panic if this header is not the RPL Source Routing Header routing type.

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

Return the address vector in bytes

Panics

This function may panic if this header is not the RPL Source Routing Header routing type.

impl<T: AsRef<[u8]> + AsMut<[u8]>> Header<T>

Core setter methods relevant to any routing type.

pub fn set_next_header(&mut self, value: Protocol)

Set the next header field.

pub fn set_header_len(&mut self, value: u8)

Set the option data length. Length of the Routing header in 8-octet units.

pub fn set_routing_type(&mut self, value: Type)

Set the routing type.

pub fn set_segments_left(&mut self, value: u8)

Set the segments left field.

pub fn clear_reserved(&mut self)

Initialize reserved fields to 0.

Panics

This function may panic if the routing type is not set.

impl<T: AsRef<[u8]> + AsMut<[u8]>> Header<T>

Setter methods for the RPL Source Routing Header routing type.

pub fn set_home_address(&mut self, value: Address)

Set the Ipv6 Home Address

Panics

This function may panic if this header is not the Type 2 Routing Header routing type.

impl<T: AsRef<[u8]> + AsMut<[u8]>> Header<T>

Setter methods for the RPL Source Routing Header routing type.

pub fn set_cmpr_i(&mut self, value: u8)

Set the number of prefix octects elided from addresses[1..n-1].

Panics

This function may panic if this header is not the RPL Source Routing Header routing type.

pub fn set_cmpr_e(&mut self, value: u8)

Set the number of prefix octects elided from the last address (addresses[n]).

Panics

This function may panic if this header is not the RPL Source Routing Header routing type.

pub fn set_pad(&mut self, value: u8)

Set the number of octects used for padding after addresses[n].

Panics

This function may panic if this header is not the RPL Source Routing Header routing type.

pub fn set_addresses(&mut self, value: &[u8])

Set address data

Panics

This function may panic if this header is not the RPL Source Routing Header routing type.

Trait Implementations

impl<T: Debug + AsRef<[u8]>> Debug for Header<T>

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

Formats the value using the given formatter.

impl<'a, T: AsRef<[u8]> + ?Sized> Display for Header<&'a T>

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

Formats the value using the given formatter.

impl<T: PartialEq + AsRef<[u8]>> PartialEq<Header<T>> for Header<T>

fn eq(&self, other: &Header<T>) -> 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<T: AsRef<[u8]>> StructuralPartialEq for Header<T>