Struct pnet_packet::usbpcap::UsbPcapPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> UsbPcapPacket<'a>

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

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

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

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

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

Maps from a UsbPcapPacket to a UsbPcapPacket

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

Maps from a UsbPcapPacket 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 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)

Trait Implementations

impl<'p> Debug for UsbPcapPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for UsbPcapPacket<'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> Packet for UsbPcapPacket<'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 UsbPcapPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for UsbPcapPacket<'p>

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