Struct Packet 

pub struct Packet { /* private fields */ }

Ordered stack of packet layers.

Implementations

impl Packet

pub const fn new() -> Self

Create an empty packet.

pub fn from_layer<L>(layer: L) -> Self

where L: Layer,

Create a packet containing one layer.

pub fn push<L>(self, layer: L) -> Self

where L: Layer,

Append a concrete layer and return the packet for builder chaining.

pub fn push_box(self, layer: Box<dyn Layer>) -> Self

Append a boxed layer and return the packet for builder chaining.

pub fn push_mut<L>(&mut self, layer: L) -> &mut Self

where L: Layer,

Mutably append a concrete layer.

pub fn push_box_mut(&mut self, layer: Box<dyn Layer>) -> &mut Self

Mutably append a boxed layer.

pub fn concat(self, other: impl IntoPacket) -> Self

Append all layers from another packet.

pub fn extend(&mut self, other: impl IntoPacket) -> &mut Self

Mutably append all layers from another packet.

pub fn pop(&mut self) -> Option<Box<dyn Layer>>

Remove and return the final layer.

pub fn pop_typed<T>(&mut self) -> Option<T>

where T: Layer,

Remove and return the final layer when it has type T.

pub fn len(&self) -> usize

Number of layers in the packet.

pub fn is_empty(&self) -> bool

Return true when the packet contains no layers.

pub fn encoded_len(&self) -> usize

Return the encoded byte length implied by the current layers.

pub fn get(&self, index: usize) -> Option<&dyn Layer>

Positional layer access.

pub fn get_mut(&mut self, index: usize) -> Option<&mut dyn Layer>

Mutable positional layer access.

pub fn layer<T>(&self) -> Option<&T>

where T: Layer,

First layer of type T.

pub fn layer_mut<T>(&mut self) -> Option<&mut T>

where T: Layer,

First mutable layer of type T.

pub fn layers<T>(&self) -> impl Iterator<Item = &T>

where T: Layer,

All layers of type T, preserving packet order.

pub fn layers_mut<T>(&mut self) -> impl Iterator<Item = &mut T>

where T: Layer,

All mutable layers of type T, preserving packet order.

pub fn iter(&self) -> impl Iterator<Item = &dyn Layer>

Ordered layer iteration.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut dyn Layer>

Ordered mutable layer iteration.

pub fn compile(&self) -> Result<CompiledPacket>

Compile the packet into deterministic bytes.

pub fn compile_into(&self, out: &mut Vec<u8>) -> Result<()>

Append compiled bytes into an existing buffer.

pub fn decode_raw(bytes: impl AsRef<[u8]>) -> Result<Self>

Decode bytes as raw payload.

pub fn decode_from_link( link_type: LinkType, bytes: impl AsRef<[u8]>, ) -> Result<Self>

Decode bytes from a link-layer entrypoint.

pub fn decode_from_link_with_registry( registry: &ProtocolRegistry, link_type: LinkType, bytes: impl AsRef<[u8]>, ) -> Result<Self>

Decode bytes from a link-layer entrypoint using an explicit registry.

pub fn decode_from_l3( network_layer: NetworkLayer, bytes: impl AsRef<[u8]>, ) -> Result<Self>

Decode bytes from a network-layer entrypoint.

pub fn decode_from_l3_with_registry( registry: &ProtocolRegistry, network_layer: NetworkLayer, bytes: impl AsRef<[u8]>, ) -> Result<Self>

Decode bytes from a network-layer entrypoint using an explicit registry.

pub fn summary(&self) -> String

One-line packet summary.

pub fn show(&self) -> String

Multi-line packet tree intended for display in examples and tools.

pub fn hexdump(&self) -> Result<String>

Compile and return a canonical hex dump.

pub fn raw_string_lossy(&self) -> Result<String>

Compile and return raw bytes as a lossy UTF-8 string.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl Default for Packet

fn default() -> Packet

Returns the “default value” for a type.

impl<R> Div<R> for Packet

where R: IntoPacket,

type Output = Packet

The resulting type after applying the / operator.

fn div(self, rhs: R) -> Self::Output

Performs the / operation.

impl IntoPacket for Packet

fn into_packet(self) -> Packet

Convert this value into a packet.

impl PacketSendExt for Packet

fn send_plan(&self, options: impl Into<SendOptions>) -> Result<SendPlan>

Build a compile-only send plan.

fn send_dry_run(&self, options: impl Into<SendOptions>) -> Result<SendPlan>

Compile and plan a send without transmitting bytes.

fn send(&self, options: impl Into<SendOptions>) -> Result<SendReport>

Send a packet according to the supplied options.

impl PacketSendRecvExt for Packet

fn reply_filter(&self) -> Result<String>

Derive a BPF-style filter for likely replies.

fn send_recv(&self, options: impl Into<SendRecv>) -> Result<Option<Packet>>

Send a packet and return the first matching reply, if any.

fn send_recv_report( &self, options: impl Into<SendRecv>, ) -> Result<SendRecvReport>

Send a packet and return a detailed send/receive report.