Skip to main content

NodeIdentity

Struct NodeIdentity 

Source
pub struct NodeIdentity {
    pub v: u8,
    pub id: String,
    pub nm: Option<String>,
    pub pr: Option<String>,
    pub ver: Option<String>,
    pub pv: Option<u16>,
    pub pl: Option<String>,
}
Expand description

A drone’s identity, sent less often than status because it does not change.

This is the frame that lets a ground station answer “who is my peer” with the node’s real identity. The presence beacon carries a device id, but the beacon is a fixed 68-byte HMAC-signed frame with its identity field already full, so there is no room in it for a name or an agent version.

Fields§

§v: u8

Schema version (NODE_STATUS_VERSION).

§id: String

The node’s persistent device id, the key everything else correlates on.

§nm: Option<String>

Human-facing node name, when the node has one configured.

§pr: Option<String>

The node’s profile (drone, ground-station, …), when known.

§ver: Option<String>

Agent version string.

§pv: Option<u16>

The highest plugin contract version any installed plugin declares, a coarse node-wide signal a peer can glance at. The authoritative per-plugin detail is Self::pl. Absent when no plugin is installed.

§pl: Option<String>

The installed plugin inventory as a comma-joined list of pluginId@contractVersion, clipped to MAX_PLUGIN_LIST. Lets a peer compare per-plugin contract versions and detect an AD05-class wire disagreement instead of silently misreading a field.

Implementations§

Source§

impl NodeIdentity

Source

pub fn build( device_id: &str, name: Option<&str>, profile: Option<&str>, version: Option<&str>, plugins: &[(String, u16)], ) -> Self

Build a bounded identity frame. Every field is clipped here, so no caller can put an unbounded string on the lane.

Source

pub fn encode(&self) -> Option<Vec<u8>>

Encode to msgpack. None when the frame would exceed one aux payload, which the field caps make unreachable; it is a guard, not a path.

Source

pub fn decode(bytes: &[u8]) -> Option<Self>

Decode a msgpack identity frame, rejecting an unrecognised schema version and an empty device id (an id-less identity correlates to nothing and is worse than no frame at all).

Trait Implementations§

Source§

impl Clone for NodeIdentity

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NodeIdentity

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for NodeIdentity

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for NodeIdentity

Source§

impl PartialEq for NodeIdentity

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for NodeIdentity

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for NodeIdentity

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more