Struct pnet_packet::vxlan::VxlanPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> VxlanPacket<'a>

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

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

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

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

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

Maps from a VxlanPacket to a VxlanPacket

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

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

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

pub fn get_flags(&self) -> u8

Get the flags field.

pub fn get_reserved1(&self) -> u24be

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

pub fn get_vni(&self) -> u24be

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

pub fn get_reserved2(&self) -> u8

Get the reserved2 field.

Trait Implementations

impl<'p> Debug for VxlanPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for VxlanPacket<'p>

type T = Vxlan

The type of the packet to convert from.

fn from_packet(&self) -> Vxlan

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

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

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for VxlanPacket<'p>

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