Struct AddAddress 

pub struct AddAddress {
    pub sequence: u64,
    pub priority: u64,
    pub transport_type: TransportType,
    pub address: TransportAddr,
    pub capabilities: Option<CapabilityFlags>,
}

ADD_ADDRESS frame for advertising candidate addresses

As defined in draft-seemann-quic-nat-traversal-01, this frame includes:

• Sequence number (VarInt)
• Priority (VarInt)
• Transport type (VarInt) - extension for multi-transport support
• Address (transport-specific format)
• Capability flags (VarInt, optional) - extension for capability advertisement

Wire Format

Sequence (VarInt)
Priority (VarInt)
TransportType (VarInt): 0=UDP, 1=BLE, 2=LoRa, 3=Serial, etc.
AddressType (1 byte): depends on transport type
Address (variable): transport-specific address bytes
Port (2 bytes): for UDP addresses only
HasCapabilities (1 byte): 0=no, 1=yes
Capabilities (2 bytes): if HasCapabilities==1, CapabilityFlags bitfield

Backward Compatibility

When decoding, if transport_type is not present (legacy frames), UDP is assumed. When encoding, transport_type 0 (UDP) uses the legacy format for compatibility. Capability flags are optional and default to None for backward compatibility.

Fields

sequence: u64

Sequence number for the address (used for referencing in other frames)

priority: u64

Priority of this address candidate (higher values are preferred)

transport_type: TransportType

Transport type for this address (UDP, BLE, LoRa, etc.)

address: TransportAddr

The transport address being advertised

capabilities: Option<CapabilityFlags>

Optional capability flags summarizing transport characteristics

Implementations

impl AddAddress

pub fn udp(sequence: u64, priority: u64, socket_addr: SocketAddr) -> Self

Create a new ADD_ADDRESS frame for a UDP address

This is the most common case and maintains backward compatibility. No capability flags are included by default.

pub fn new(sequence: u64, priority: u64, address: TransportAddr) -> Self

Create a new ADD_ADDRESS frame for any transport address

No capability flags are included by default. Use with_capabilities() to add capability information.

pub fn with_capabilities( sequence: u64, priority: u64, address: TransportAddr, capabilities: CapabilityFlags, ) -> Self

Create a new ADD_ADDRESS frame with capability flags

pub fn from_capabilities( sequence: u64, priority: u64, address: TransportAddr, capabilities: &TransportCapabilities, ) -> Self

Create a new ADD_ADDRESS frame from a TransportAddr and TransportCapabilities

This automatically converts the full capabilities to compact CapabilityFlags.

pub fn socket_addr(&self) -> Option<SocketAddr>

Get the socket address if this is a UDP transport

Returns None for non-UDP transports.

pub fn has_capabilities(&self) -> bool

Check if this address has capability information

pub fn capability_flags(&self) -> Option<CapabilityFlags>

Get the capability flags if present

pub fn supports_full_quic(&self) -> Option<bool>

Check if this transport supports full QUIC (if capability info is available)

impl AddAddress

pub fn encode_with_type<B: BufMut>(&self, buf: &mut B)

Encode this frame with its type prefix for transmission

Trait Implementations

impl Clone for AddAddress

fn clone(&self) -> AddAddress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Codec for AddAddress

fn decode<B: Buf>(buf: &mut B) -> Result<Self>

Decode a Self from the provided buffer, if the buffer is large enough

fn encode<B: BufMut>(&self, buf: &mut B)

Append the encoding of self to the provided buffer

impl Debug for AddAddress

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

Formats the value using the given formatter.

impl PartialEq for AddAddress

fn eq(&self, other: &AddAddress) -> 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 Eq for AddAddress

impl StructuralPartialEq for AddAddress