Struct NodeIdentityPayload 

pub struct NodeIdentityPayload {
    pub role: NodeRole,
    pub capabilities: NodeCapabilities,
    pub name: Option<String>,
    pub location: Option<NodeLocation>,
    pub altitude_m: Option<i32>,
    pub timestamp: Option<u32>,
    pub supported_regions: Option<Vec<String>>,
    pub nonce: Option<u32>,
    pub signature: Option<[u8; 64]>,
}

Fields

role: NodeRole

capabilities: NodeCapabilities

name: Option<String>

Option 0 — display name (UTF-8).

location: Option<NodeLocation>

Option 1 — geographic position.

altitude_m: Option<i32>

Option 2 — altitude above mean sea level, in meters.

timestamp: Option<u32>

Option 3 — seconds since the Unix epoch (freshness marker).

supported_regions: Option<Vec<String>>

Option 4 — the regions this repeater floods for, in their string form, one repetition of the option per region.

The string travels rather than the derived code because the code is always recoverable from the string while a hash-derived code cannot be turned back into a name. A node lists at most [MAX_SUPPORTED_REGIONS], and a list that does not fit its packet is legitimately shortened, so this names regions the node forwards for without promising to name them all (node-identity.md § Supported Regions).

nonce: Option<u32>

Option 5 — nonce echoed from a soliciting Advertisement Request. Present only in solicited advertisements whose request carried one.

signature: Option<[u8; 64]>

EdDSA signature over ROLE..=0xFF, present when the identity stands alone.

TODO: signing and verification belong outside NodeIdentityPayload (the way the source-address routing hint lives outside the payload). The eventual rework should remove this field and move the signed-identity wrapper to a separate type that owns both the encoded payload bytes and the signature, so the signed-byte range is never reconstructed at the call site.

Implementations

impl NodeIdentityPayload

pub fn from_bytes(payload: &[u8]) -> Result<NodeIdentityPayload, AppParseError>

pub fn encode(&self, buf: &mut [u8]) -> Result<usize, AppEncodeError>

pub fn encode_fitting(&self, buf: &mut [u8]) -> Result<usize, AppEncodeError>

Encode, dropping regions from the end of the list until the result fits.

The region list is the one part of an identity that is allowed to arrive incomplete: it names regions the node forwards for without promising to name every one (node-identity.md § Supported Regions). Everything else in the payload is a fact about the node, so a buffer too small to hold it after the last region is gone is still an error.

pub fn encode_for_signing( &self, buf: &mut [u8], ) -> Result<usize, AppEncodeError>

Encode the signed byte range — ROLE through the 0xFF options terminator, inclusive — for a detached signing step. self.signature is ignored; the caller signs exactly the returned bytes and appends the 64-byte signature to produce the standalone (signed) wire form:

let len = payload.encode_for_signing(&mut buf)?;
let signature = identity.sign(&buf[..len]).await?;
buf[len..len + 64].copy_from_slice(&signature);
// buf[..len + 64] now parses with `signature: Some(..)`.

Trait Implementations

impl Clone for NodeIdentityPayload

fn clone(&self) -> NodeIdentityPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeIdentityPayload

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

Formats the value using the given formatter.

impl PartialEq for NodeIdentityPayload

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

impl StructuralPartialEq for NodeIdentityPayload