Struct packet_formats::icmp::ndp::options::PrefixInformation

#[repr(C)]
pub struct PrefixInformation { /* private fields */ }

Prefix information that is advertised by a router in Router Advertisements.

See RFC 4861 section 4.6.2.

Implementations

impl PrefixInformation

pub fn new( prefix_length: u8, on_link_flag: bool, autonomous_address_configuration_flag: bool, valid_lifetime: u32, preferred_lifetime: u32, prefix: Ipv6Addr, ) -> Self

Create a new PrefixInformation.

pub fn prefix_length(&self) -> u8

The number of leading bits in the prefix that are valid.

pub fn on_link_flag(&self) -> bool

Is this prefix on the link?

Returns true if the prefix is on-link. false means that no statement is made about on or off-link properties of the prefix; nodes MUST NOT conclude that an address derived from this prefix is off-link if false.

pub fn autonomous_address_configuration_flag(&self) -> bool

Can this prefix be used for stateless address configuration?

pub fn valid_lifetime(&self) -> Option<NonZeroNdpLifetime>

Get the length of time (relative to the time the packet is sent) that the prefix is valid for the purpose of on-link determination and SLAAC.

None indicates that the prefix has no valid lifetime and should not be considered valid.

pub fn preferred_lifetime(&self) -> Option<NonZeroNdpLifetime>

Get the length of time (relative to the time the packet is sent) that addresses generated from the prefix via SLAAC remains preferred.

None indicates that the prefix has no preferred lifetime and should not be considered preferred.

pub fn prefix(&self) -> &Ipv6Addr

An IPv6 address or a prefix of an IPv6 address.

The number of valid leading bits in this prefix is available from PrefixInformation::prefix_length;

pub fn subnet(&self) -> Result<Subnet<Ipv6Addr>, SubnetError>

Gets the prefix as a Subnet.

Trait Implementations

impl Clone for PrefixInformation

fn clone(&self) -> PrefixInformation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrefixInformation

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

Formats the value using the given formatter.

impl FromBytes for PrefixInformation

where u8: FromBytes, U32: FromBytes, [u8; 4]: FromBytes, Ipv6Addr: FromBytes,

fn ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the given source as a &Self.

fn ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the prefix of the given source as a &Self without copying.

fn ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: Immutable + KnownLayout,

Interprets the suffix of the given bytes as a &Self.

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the prefix of the given source as a &mut Self without copying.

fn mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the suffix of the given source as a &mut Self without copying.

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl FromZeros for PrefixInformation

where u8: FromZeros, U32: FromZeros, [u8; 4]: FromZeros, Ipv6Addr: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl IntoBytes for PrefixInformation

where u8: IntoBytes, U32: IntoBytes, [u8; 4]: IntoBytes, Ipv6Addr: IntoBytes, (): PaddingFree<PrefixInformation, { _ }>,

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl KnownLayout for PrefixInformation

where Ipv6Addr: KnownLayout,

type PointerMetadata = <Ipv6Addr as KnownLayout>::PointerMetadata

The type of metadata stored in a pointer to Self.

impl PartialEq for PrefixInformation

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

where u8: TryFromBytes, U32: TryFromBytes, [u8; 4]: TryFromBytes, Ipv6Addr: TryFromBytes,

fn try_ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the given source as a &Self.

fn try_ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the prefix of the given source as a &Self.

fn try_ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the suffix of the given source as a &Self.

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl Eq for PrefixInformation

impl Immutable for PrefixInformation

where u8: Immutable, U32: Immutable, [u8; 4]: Immutable, Ipv6Addr: Immutable,

impl StructuralPartialEq for PrefixInformation

impl Unaligned for PrefixInformation

where u8: Unaligned, U32: Unaligned, [u8; 4]: Unaligned, Ipv6Addr: Unaligned,