Struct pnet_packet::dhcp::MutableDhcpPacket

pub struct MutableDhcpPacket<'p> { /* private fields */ }

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableDhcpPacket<'a>

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

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

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

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

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

Maps from a MutableDhcpPacket to a DhcpPacket

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

Maps from a MutableDhcpPacket to a DhcpPacket 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: &Dhcp) -> usize

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

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

Populates a DhcpPacket using a Dhcp structure

pub fn get_op(&self) -> DhcpOperation

Get the value of the op field

pub fn get_htype(&self) -> DhcpHardwareType

Get the value of the htype field

pub fn get_hlen(&self) -> u8

Get the hlen field.

pub fn get_hops(&self) -> u8

Get the hops field.

pub fn get_xid(&self) -> u32be

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

pub fn get_secs(&self) -> u16be

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

pub fn get_flags(&self) -> u16be

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

pub fn get_ciaddr(&self) -> Ipv4Addr

Get the value of the ciaddr field

pub fn get_yiaddr(&self) -> Ipv4Addr

Get the value of the yiaddr field

pub fn get_siaddr(&self) -> Ipv4Addr

Get the value of the siaddr field

pub fn get_giaddr(&self) -> Ipv4Addr

Get the value of the giaddr field

pub fn get_chaddr(&self) -> MacAddr

Get the value of the chaddr field

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

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

pub fn get_chaddr_pad(&self) -> Vec<u8>

Get the value of the chaddr_pad field (copies contents)

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

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

pub fn get_sname(&self) -> Vec<u8>

Get the value of the sname field (copies contents)

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

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

pub fn get_file(&self) -> Vec<u8>

Get the value of the file field (copies contents)

pub fn set_op(&mut self, val: DhcpOperation)

Set the value of the op field.

pub fn set_htype(&mut self, val: DhcpHardwareType)

Set the value of the htype field.

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

Set the hlen field.

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

Set the hops field.

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

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

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

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

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

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

pub fn set_ciaddr(&mut self, val: Ipv4Addr)

Set the value of the ciaddr field.

pub fn set_yiaddr(&mut self, val: Ipv4Addr)

Set the value of the yiaddr field.

pub fn set_siaddr(&mut self, val: Ipv4Addr)

Set the value of the siaddr field.

pub fn set_giaddr(&mut self, val: Ipv4Addr)

Set the value of the giaddr field.

pub fn set_chaddr(&mut self, val: MacAddr)

Set the value of the chaddr field.

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

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

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

Set the value of the chaddr_pad field (copies contents)

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

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

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

Set the value of the sname field (copies contents)

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

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

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

Set the value of the file field (copies contents)

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

Set the value of the options field (copies contents)

Trait Implementations

impl<'p> Debug for MutableDhcpPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableDhcpPacket<'p>

type T = Dhcp

The type of the packet to convert from.

fn from_packet(&self) -> Dhcp

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

impl<'a> MutablePacket for MutableDhcpPacket<'a>

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

Retrieve the underlying, mutable, buffer for the packet.

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

Retrieve 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 MutableDhcpPacket<'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 MutableDhcpPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for MutableDhcpPacket<'p>

fn eq(&self, other: &MutableDhcpPacket<'p>) -> 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<'p> StructuralPartialEq for MutableDhcpPacket<'p>