Struct PacketMeta

#[non_exhaustive]
pub struct PacketMeta {}

Metadata associated to a packet.

The packet metadata is a set of attributes associated to network packets as they travel up or down the stack. The metadata is get/set by the Device implementations or by the user when sending/receiving packets from a socket.

Metadata fields are enabled via Cargo features. If no field is enabled, this struct becomes zero-sized, which allows the compiler to optimize it out as if the packet metadata mechanism didn’t exist at all.

Currently only UDP sockets allow setting/retrieving packet metadata. The metadata for packets emitted with other sockets will be all default values.

This struct is marked as #[non_exhaustive]. This means it is not possible to create it directly by specifying all fields. You have to instead create it with default values and then set the fields you want. This makes adding metadata fields a non-breaking change.

let mut meta = smoltcp::phy::PacketMeta::default();
#[cfg(feature = "packetmeta-id")]
{
    meta.id = 15;
}

Trait Implementations

impl Clone for PacketMeta

fn clone(&self) -> PacketMeta

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PacketMeta

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

Formats the value using the given formatter.

impl Default for PacketMeta

fn default() -> PacketMeta

Returns the “default value” for a type.

impl Hash for PacketMeta

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PacketMeta

fn eq(&self, other: &PacketMeta) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PacketMeta

impl Eq for PacketMeta

impl StructuralPartialEq for PacketMeta