Struct xenet_packet::sll2::MutableSLL2Packet

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableSLL2Packet<'a>

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

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

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

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

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

Maps from a MutableSLL2Packet to a SLL2Packet

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

Maps from a MutableSLL2Packet to a SLL2Packet 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: &SLL2) -> usize

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

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

Populates a SLL2Packet using a SLL2 structure

pub fn get_protocol_type(&self) -> EtherType

Get the value of the protocol_type field

pub fn get_reserved(&self) -> u16be

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

pub fn get_interface_index(&self) -> u32be

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

pub fn get_arphrd_type(&self) -> u16be

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

pub fn get_packet_type(&self) -> u8

Get the packet_type field.

pub fn get_link_layer_address_length(&self) -> u8

Get the link_layer_address_length field.

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

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

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

Get the value of the link_layer_address field (copies contents)

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

Set the value of the protocol_type field.

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

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

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

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

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

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

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

Set the packet_type field.

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

Set the link_layer_address_length field.

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

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

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

Set the value of the link_layer_address field (copies contents)

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

Set the value of the payload field (copies contents)

Trait Implementations

impl<'p> Debug for MutableSLL2Packet<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableSLL2Packet<'p>

type T = SLL2

The type of the packet to convert from.

fn from_packet(&self) -> SLL2

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

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

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for MutableSLL2Packet<'p>

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