Struct pnet_packet::ethernet::MutableEthernetPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableEthernetPacket<'a>

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

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

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

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

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

Maps from a MutableEthernetPacket to a EthernetPacket

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

Maps from a MutableEthernetPacket to a EthernetPacket 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: &Ethernet) -> usize

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

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

Populates a EthernetPacket using a Ethernet structure

pub fn get_destination(&self) -> MacAddr

Get the value of the destination field

pub fn get_source(&self) -> MacAddr

Get the value of the source field

pub fn get_ethertype(&self) -> EtherType

Get the value of the ethertype field

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

Set the value of the destination field.

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

Set the value of the source field.

pub fn set_ethertype(&mut self, val: EtherType)

Set the value of the ethertype field.

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

Set the value of the payload field (copies contents)

Trait Implementations

impl<'p> Debug for MutableEthernetPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableEthernetPacket<'p>

type T = Ethernet

The type of the packet to convert from.

fn from_packet(&self) -> Ethernet

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

impl<'a> MutablePacket for MutableEthernetPacket<'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 MutableEthernetPacket<'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 MutableEthernetPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq<MutableEthernetPacket<'p>> for MutableEthernetPacket<'p>

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

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

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

This method tests for !=.

impl<'p> StructuralPartialEq for MutableEthernetPacket<'p>