Struct pnet::packet::icmpv6::ndp::MutableNeighborAdvertPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableNeighborAdvertPacket<'a>

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

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

pub fn owned(
    packet: Vec<u8, Global>
) -> Option<MutableNeighborAdvertPacket<'static>>

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

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

Maps from a MutableNeighborAdvertPacket to a NeighborAdvertPacket

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

Maps from a MutableNeighborAdvertPacket to a NeighborAdvertPacket 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: &NeighborAdvert) -> usize

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

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

Populates a NeighborAdvertPacket using a NeighborAdvert 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) -> u16

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

pub fn get_flags(&self) -> u8

Get the flags field.

pub fn get_reserved(&self) -> u32

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

pub fn get_target_addr(&self) -> Ipv6Addr

Get the value of the target_addr field

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, Global>

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: u16)

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

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

Set the flags field.

pub fn set_reserved(&mut self, val: u32)

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

pub fn set_target_addr(&mut self, val: Ipv6Addr)

Set the value of the target_addr field.

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 MutableNeighborAdvertPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableNeighborAdvertPacket<'p>

type T = NeighborAdvert

The type of the packet to convert from.

pub fn from_packet(&self) -> NeighborAdvert

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

impl<'a> MutablePacket for MutableNeighborAdvertPacket<'a>

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

Retreive the underlying, mutable, buffer for the packet.

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

Retreive the mutable payload for the packet.

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

Initialize this packet by cloning another.

impl<'a> Packet for MutableNeighborAdvertPacket<'a>

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

Retrieve the underlying buffer for the packet.

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

Retrieve the payload for the packet.

impl<'a> PacketSize for MutableNeighborAdvertPacket<'a>

pub fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq<MutableNeighborAdvertPacket<'p>> for MutableNeighborAdvertPacket<'p>

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

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

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

This method tests for !=.

impl<'p> StructuralPartialEq for MutableNeighborAdvertPacket<'p>