Struct netsim_embed::vlan::MutableVlanPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableVlanPacket<'a>

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

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

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

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

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

Maps from a #name to a #imm_name

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

Maps from a #name to a #imm_name 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 #base_name instance when converted into a byte-array

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

Populates a {name}Packet using a {name} structure

pub fn get_priority_code_point(&self) -> ClassOfService

Get the value of the {name} field

pub fn get_drop_eligible_indicator(&self) -> u8

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

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 {name} field

pub fn get_payload(&self) -> Vec<u8, Global>

Get the value of the {name} field (copies contents)

pub fn set_priority_code_point(&mut self, val: ClassOfService)

Set the value of the {name} field.

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

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

pub fn set_vlan_identifier(&mut self, val: u16)

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

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

Set the value of the {name} field.

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

Set the value of the {name} field (copies contents)

Trait Implementations

impl<'p> Debug for MutableVlanPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableVlanPacket<'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> MutablePacket for MutableVlanPacket<'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 MutableVlanPacket<'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 MutableVlanPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq<MutableVlanPacket<'p>> for MutableVlanPacket<'p>

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