Struct VxlanHdr 

#[repr(C)]
pub struct VxlanHdr {
    pub flags: u8,
    pub _reserved1: [u8; 3],
    pub vni: [u8; 3],
    pub _reserved2: u8,
}

VXLAN (Virtual eXtensible Local Area Network) header.

Encapsulates OSI layer 2 Ethernet frames within layer 4 UDP packets. Uses a 24-bit VXLAN Network Identifier (VNI) for traffic segregation. Header length: 8 bytes. Reference: RFC 7348.

Fields

flags: u8

Flags (8 bits). Bit 3 (I flag) must be 1 if VNI is present. Other bits are reserved (R).

_reserved1: [u8; 3]

Reserved field (24 bits). Must be zero on transmission.

vni: [u8; 3]

Contains the 24-bit VNI (upper 3 bytes) and an 8-bit reserved field (the lowest byte). The reserved field (the lowest byte) must be zero on transmission.

_reserved2: u8

Implementations

impl VxlanHdr

pub const LEN: usize

Length of the VXLAN header in bytes (8 bytes).

pub fn new(vni: u32) -> Self

Creates a new VxlanHdr.

Sets the I-flag, zeros reserved fields, and sets the VNI.

Parameters

• vni: The 24-bit VXLAN Network Identifier.

Returns

A new VxlanHdr instance.

pub fn with_flags(flags: u8, vni: [u8; 3]) -> Self

Creates a new VxlanHdr.

Sets the I-flag, zeros reserved fields, and sets the VNI.

Parameters

• flags: The 8-bit value to set for the flag field.
• vni: The 24-bit VXLAN Network Identifier.

Returns

A new VxlanHdr instance.

pub fn flags(&self) -> u8

Returns the raw flags’ byte.

Returns

The 8-bit flags field.

pub fn set_flags(&mut self, flags: u8)

Sets the raw flags byte.

Parameters

• flags: The 8-bit value to set for the flags field.

pub fn vni_present(&self) -> bool

Checks if the I-flag (VNI Present) is set.

Returns

true if the I-flag is set, false otherwise.

pub fn set_vni_present(&mut self, present: bool)

Sets or clears the I-flag (VNI Present).

Preserves other flag bits.

Parameters

• present: If true, sets the I-flag; otherwise, clears it.

pub fn vni(&self) -> u32

Returns the VXLAN Network Identifier (VNI).

Returns

The 24-bit VNI as a u32.

pub fn set_vni(&mut self, vni: u32)

Sets the VXLAN Network Identifier (VNI).

Masks the input vni to 24 bits. Preserves the reserved2 field.

Parameters

• vni: The 24-bit VNI value.

Trait Implementations

impl Clone for VxlanHdr

fn clone(&self) -> VxlanHdr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VxlanHdr

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

Formats the value using the given formatter.

impl<'de, WincodeConfig: Config> SchemaRead<'de, WincodeConfig> for VxlanHdr

const TYPE_META: TypeMeta

Metadata about the type’s serialization.

type Dst = VxlanHdr

fn read( reader: impl Reader<'de>, dst: &mut MaybeUninit<Self::Dst>, ) -> ReadResult<()>

Read into dst from reader.

fn get(reader: impl Reader<'de>) -> Result<Self::Dst, ReadError>

Read Self::Dst from reader into a new Self::Dst.

impl<WincodeConfig: Config> SchemaWrite<WincodeConfig> for VxlanHdr

const TYPE_META: TypeMeta

Metadata about the type’s serialization.

type Src = VxlanHdr

fn size_of(src: &Self::Src) -> WriteResult<usize>

Get the serialized size of Self::Src.

fn write(writer: impl Writer, src: &Self::Src) -> WriteResult<()>

Write Self::Src to writer.

impl<WincodeConfig: Config> ZeroCopy<WincodeConfig> for VxlanHdr

where for<'_wincode_internal, '_wincode_internal> u8: ZeroCopy<WincodeConfig>, for<'_wincode_internal, '_wincode_internal> [u8; 3]: ZeroCopy<WincodeConfig>, for<'_wincode_internal> Assert<{ _ }>: IsTrue,

fn from_bytes<'de>(bytes: &'de [u8], config: C) -> Result<&'de Self, ReadError>

where Self: Sized + SchemaRead<'de, C, Dst = Self>,

Like crate::ZeroCopy::from_bytes, but allows the caller to provide a custom configuration.

fn from_bytes_mut<'de>( bytes: &'de mut [u8], config: C, ) -> Result<&'de mut Self, ReadError>

where Self: Sized + SchemaRead<'de, C, Dst = Self>,

Like crate::ZeroCopy::from_bytes_mut, but allows the caller to provide a custom configuration.

impl Copy for VxlanHdr