Struct pnet_packet::usbpcap::MutableUsbPcapPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableUsbPcapPacket<'a>

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

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

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

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

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

Maps from a MutableUsbPcapPacket to a UsbPcapPacket

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

Maps from a MutableUsbPcapPacket to a UsbPcapPacket 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: &UsbPcap) -> usize

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

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

Populates a UsbPcapPacket using a UsbPcap structure

pub fn get_header_length(&self) -> u16le

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

pub fn get_irp_id(&self) -> u64le

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

pub fn get_status(&self) -> UsbPcapStatus

Get the value of the status field

pub fn get_function(&self) -> UsbPcapFunction

Get the value of the function field

pub fn get_reserved_info(&self) -> u7

Get the reserved_info field.

pub fn get_pdo_to_fdo(&self) -> u1

Get the pdo_to_fdo field.

pub fn get_bus(&self) -> u16le

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

pub fn get_device(&self) -> u16le

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

pub fn get_direction(&self) -> u1

Get the direction field.

pub fn get_reserved_endpoint(&self) -> u3

Get the reserved_endpoint field.

pub fn get_endpoint(&self) -> u4

Get the endpoint field.

pub fn get_transfer(&self) -> u8

Get the transfer field.

pub fn get_data_length(&self) -> u32le

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

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

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

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

Get the value of the header_payload field (copies contents)

pub fn set_header_length(&mut self, val: u16le)

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

pub fn set_irp_id(&mut self, val: u64le)

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

pub fn set_status(&mut self, val: UsbPcapStatus)

Set the value of the status field.

pub fn set_function(&mut self, val: UsbPcapFunction)

Set the value of the function field.

pub fn set_reserved_info(&mut self, val: u7)

Set the reserved_info field.

pub fn set_pdo_to_fdo(&mut self, val: u1)

Set the pdo_to_fdo field.

pub fn set_bus(&mut self, val: u16le)

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

pub fn set_device(&mut self, val: u16le)

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

pub fn set_direction(&mut self, val: u1)

Set the direction field.

pub fn set_reserved_endpoint(&mut self, val: u3)

Set the reserved_endpoint field.

pub fn set_endpoint(&mut self, val: u4)

Set the endpoint field.

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

Set the transfer field.

pub fn set_data_length(&mut self, val: u32le)

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

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

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

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

Set the value of the header_payload 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 MutableUsbPcapPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableUsbPcapPacket<'p>

type T = UsbPcap

The type of the packet to convert from.

fn from_packet(&self) -> UsbPcap

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

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

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq<MutableUsbPcapPacket<'p>> for MutableUsbPcapPacket<'p>

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

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

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

This method tests for !=.

impl<'p> StructuralPartialEq for MutableUsbPcapPacket<'p>