Module items

Module items 

Source
Expand description

Item codecs for the full protocol’s multi-value properties.

Each multi-value property defines an item form (what the host writes) and a digest form (what the device reports). The two differ exactly where the item form carries symmetric key material: digest forms never contain secrets. See “Multi-Value Properties” in the full ULCP spec.

Whole-table values concatenate items: fixed-size items back to back (see fixed_items), or PUI-length-prefixed items for properties documented with an item length prefix (see prefixed_items / encode_prefixed_item). Single items carried by CMD_PROP_INSERT/CMD_PROP_REMOVE are never length-prefixed; the framing layer bounds them.

Structs§

PeerKeyEntry
One PROP_HOST_PEER_KEYS entry in item form: the peer’s public key and the pairwise keys derived by the host. Secret-bearing — the digest form is Self::public_key alone.
PrefixedItems

Enums§

Filter
One PROP_HOST_RX_FILTERS entry. Item and digest forms are identical; the remove selector is the full item.
ItemError

Constants§

CHANNEL_ID_LEN
Length of a derived channel identifier (the digest form of a channel key).
CHANNEL_KEY_LEN
Length of a channel key item (PROP_HOST_CHANNEL_KEYS, PROP_DEV_CHANNEL_KEYS).
FILTER_CHANNEL_ID
FILTER_TYPE for a 2-octet channel-identifier filter.
FILTER_DEST_HINT
FILTER_TYPE for a 3-octet destination-hint filter.
FILTER_PKT_TYPE
FILTER_TYPE for a 1-octet FCF packet-type filter.
PUBLIC_KEY_LEN
Length of an Ed25519 public key (peer entries, PROP_HOST_KEY, PROP_DEV_KEY).
REGION_CODE_LEN
Length of a routing-domain region code (PROP_MAC_REPEATER_REGIONS, PROP_MAC_REPEATER_DEFAULT_REGION, and the Supported Regions node-identity option they mirror).

Functions§

encode_prefixed_item
Append one PUI-length-prefixed item to out, returning the number of bytes written.
fixed_items
Iterate the fixed-size items of a whole-table value with no item length prefix (channel keys, peer public keys, peer key entries).
prefixed_items
Iterate the PUI-length-prefixed items of a whole-table value (properties documented with an item length prefix, such as PROP_HOST_RX_FILTERS).