Struct pnet::packet::vlan::VlanPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> VlanPacket<'a>

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

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

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

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

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

Maps from a VlanPacket to a VlanPacket

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

Maps from a VlanPacket to a VlanPacket 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: &Vlan) -> usize

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

pub fn get_priority_code_point(&self) -> ClassOfService

Get the value of the priority_code_point field

pub fn get_drop_eligible_indicator(&self) -> u8

Get the drop_eligible_indicator field.

pub fn get_vlan_identifier(&self) -> u16

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

pub fn get_ethertype(&self) -> EtherType

Get the value of the ethertype field

Trait Implementations

impl<'p> Debug for VlanPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for VlanPacket<'p>

type T = Vlan

The type of the packet to convert from.

fn from_packet(&self) -> Vlan

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

impl<'a> Packet for VlanPacket<'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 VlanPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for VlanPacket<'p>

fn eq(&self, other: &VlanPacket<'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 VlanPacket<'p>