Struct PacketMeta 

#[non_exhaustive]
pub struct PacketMeta {
    pub id: u32,
}

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 Driver 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.

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 = xarxa_driver::PacketMeta::default();
#[cfg(feature = "packetmeta-id")]
{
    meta.id = 15;
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: u32

An opaque identifier for this packet.

On received packets, this is set by the [Device]. On packets to transmit, this is set by the user and passed down to the [Device]; it is also what correlates a transmit timestamp back to the packet that produced it, see [Device::poll_tx_timestamp].

Trait Implementations

impl Clone for PacketMeta

fn clone(&self) -> PacketMeta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PacketMeta

impl Debug for PacketMeta

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

Formats the value using the given formatter.

impl Default for PacketMeta

fn default() -> PacketMeta

Returns the “default value” for a type.

impl Eq for PacketMeta

impl Format for PacketMeta

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl Hash for PacketMeta

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

where __H: Hasher,

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PacketMeta