Struct pnet_packet::icmpv6::ndp::MutableRouterAdvertPacket

pub struct MutableRouterAdvertPacket<'p> { /* fields omitted */ }

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableRouterAdvertPacket<'a>

pub fn new<'p>(packet: &'p mut [u8]) -> Option<MutableRouterAdvertPacket<'p>>

Constructs a new MutableRouterAdvertPacket. If the provided buffer is less than the minimum required packet size, this will return None.

pub fn owned(packet: Vec<u8>) -> Option<MutableRouterAdvertPacket<'static>>

Constructs a new MutableRouterAdvertPacket. If the provided buffer is less than the minimum required packet size, this will return None. With this constructor the MutableRouterAdvertPacket will own its own data and the underlying buffer will be dropped when the MutableRouterAdvertPacket is.

pub fn to_immutable<'p>(&'p self) -> RouterAdvertPacket<'p>

Maps from a MutableRouterAdvertPacket to a RouterAdvertPacket

pub fn consume_to_immutable(self) -> RouterAdvertPacket<'a>

Maps from a MutableRouterAdvertPacket to a RouterAdvertPacket while consuming the source

pub const fn minimum_packet_size() -> usize

The minimum size (in bytes) a packet of this type can be. It’s based on the total size of the fixed-size fields.

pub fn packet_size(_packet: &RouterAdvert) -> usize

The size (in bytes) of a RouterAdvert instance when converted into a byte-array

pub fn populate(&mut self, packet: &RouterAdvert)

Populates a RouterAdvertPacket using a RouterAdvert structure

pub fn get_icmpv6_type(&self) -> Icmpv6Type

Get the value of the icmpv6_type field

pub fn get_icmpv6_code(&self) -> Icmpv6Code

Get the value of the icmpv6_code field

pub fn get_checksum(&self) -> u16be

Get the checksum field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_hop_limit(&self) -> u8

Get the hop_limit field.

pub fn get_flags(&self) -> u8

Get the flags field.

pub fn get_lifetime(&self) -> u16be

Get the lifetime field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_reachable_time(&self) -> u32be

Get the reachable_time field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_retrans_time(&self) -> u32be

Get the retrans_time field. This field is always stored big-endian within the struct, but this accessor returns host order.

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

Get the raw &u8 value of the options field, without copying

pub fn get_options(&self) -> Vec<NdpOption>

Get the value of the options field (copies contents)

pub fn get_options_iter(&self) -> NdpOptionIterable<'_>

Get the value of the options field as iterator

pub fn set_icmpv6_type(&mut self, val: Icmpv6Type)

Set the value of the icmpv6_type field.

pub fn set_icmpv6_code(&mut self, val: Icmpv6Code)

Set the value of the icmpv6_code field.

pub fn set_checksum(&mut self, val: u16be)

Set the checksum field. This field is always stored big-endian within the struct, but this mutator wants host order.

pub fn set_hop_limit(&mut self, val: u8)

Set the hop_limit field.

pub fn set_flags(&mut self, val: u8)

Set the flags field.

pub fn set_lifetime(&mut self, val: u16be)

Set the lifetime field. This field is always stored big-endian within the struct, but this mutator wants host order.

pub fn set_reachable_time(&mut self, val: u32be)

Set the reachable_time field. This field is always stored big-endian within the struct, but this mutator wants host order.

pub fn set_retrans_time(&mut self, val: u32be)

Set the retrans_time field. This field is always stored big-endian within the struct, but this mutator wants host order.

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

Get the raw &mut u8 value of the options field, without copying

pub fn set_options(&mut self, vals: &[NdpOption])

Set the value of the options field (copies contents)

pub fn set_payload(&mut self, vals: &[u8])

Set the value of the payload field (copies contents)

Trait Implementations

impl<'p> Debug for MutableRouterAdvertPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableRouterAdvertPacket<'p>

type T = RouterAdvert

The type of the packet to convert from.

fn from_packet(&self) -> RouterAdvert

Converts a wire-format packet to #[packet] struct format.

impl<'a> MutablePacket for MutableRouterAdvertPacket<'a>

fn packet_mut<'p>(&'p mut self) -> &'p mut [u8]

Retreive the underlying, mutable, buffer for the packet.

fn payload_mut<'p>(&'p mut self) -> &'p mut [u8]

Retreive the mutable payload for the packet.

fn clone_from<T>(&mut self, other: &T) where
    T: Packet, 

Initialize this packet by cloning another.

impl<'a> Packet for MutableRouterAdvertPacket<'a>

fn packet<'p>(&'p self) -> &'p [u8]

Retrieve the underlying buffer for the packet.

fn payload<'p>(&'p self) -> &'p [u8]

Retrieve the payload for the packet.

impl<'a> PacketSize for MutableRouterAdvertPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq<MutableRouterAdvertPacket<'p>> for MutableRouterAdvertPacket<'p>

fn eq(&self, other: &MutableRouterAdvertPacket<'p>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MutableRouterAdvertPacket<'p>) -> bool

This method tests for !=.

impl<'p> StructuralPartialEq for MutableRouterAdvertPacket<'p>