Struct smoltcp::wire::NdiscOption

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

A read/write wrapper around an NDISC Option.

Implementations

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

Core getter methods relevant to any type of NDISC option.

pub fn new_unchecked(buffer: T) -> NdiscOption<T>

Create a raw octet buffer with an NDISC Option structure.

pub fn new_checked(buffer: T) -> Result<NdiscOption<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_data_len.

pub fn into_inner(self) -> T

Consume the NDISC option, returning the underlying buffer.

pub fn option_type(&self) -> Type

Return the option type.

pub fn data_len(&self) -> u8

Return the length of the data.

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

Getter methods only relevant for Source/Target Link-layer Address options.

pub fn link_layer_addr(&self) -> EthernetAddress

Return the Source/Target Link-layer Address.

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

Getter methods only relevant for the MTU option.

pub fn mtu(&self) -> u32

Return the MTU value.

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

Getter methods only relevant for the Prefix Information option.

pub fn prefix_len(&self) -> u8

Return the prefix length.

pub fn prefix_flags(&self) -> PrefixInfoFlags

Return the prefix information flags.

pub fn valid_lifetime(&self) -> Duration

Return the valid lifetime of the prefix.

pub fn preferred_lifetime(&self) -> Duration

Return the preferred lifetime of the prefix.

pub fn prefix(&self) -> Ipv6Address

Return the prefix.

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

pub fn data(&self) -> &'a [u8]

Return the option data.

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

Core setter methods relevant to any type of NDISC option.

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

Set the option type.

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

Set the option data length.

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

Setter methods only relevant for Source/Target Link-layer Address options.

pub fn set_link_layer_addr(&mut self, addr: EthernetAddress)

Set the Source/Target Link-layer Address.

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

Setter methods only relevant for the MTU option.

pub fn set_mtu(&mut self, value: u32)

Set the MTU value.

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

Setter methods only relevant for the Prefix Information option.

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

Set the prefix length.

pub fn set_prefix_flags(&mut self, flags: PrefixInfoFlags)

Set the prefix information flags.

pub fn set_valid_lifetime(&mut self, time: Duration)

Set the valid lifetime of the prefix.

pub fn set_preferred_lifetime(&mut self, time: Duration)

Set the preferred lifetime of the prefix.

pub fn clear_prefix_reserved(&mut self)

Clear the reserved bits.

pub fn set_prefix(&mut self, addr: Ipv6Address)

Set the prefix.

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

Setter methods only relevant for the Redirected Header option.

pub fn clear_redirected_reserved(&mut self)

Clear the reserved bits.

impl<'a, T: AsRef<[u8]> + AsMut<[u8]> + ?Sized> NdiscOption<&'a mut T>

pub fn data_mut(&mut self) -> &mut [u8]

Return a mutable pointer to the option data.

Trait Implementations

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

fn eq(&self, other: &NdiscOption<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]>> PrettyPrint for NdiscOption<T>

fn pretty_print(
    buffer: &dyn AsRef<[u8]>,
    f: &mut Formatter<'_>,
    indent: &mut PrettyIndent
) -> Result

Write a concise, formatted representation of a packet contained in the provided buffer, and any nested packets it may contain.

impl<T: AsRef<[u8]>> StructuralPartialEq for NdiscOption<T>