Skip to main content

NodeStatus

Struct NodeStatus 

Source
pub struct NodeStatus {
Show 28 fields pub peer_id: PeerId, pub local_addr: SocketAddr, pub external_addrs: Vec<SocketAddr>, pub nat_type: NatType, pub can_receive_direct: bool, pub direct_reachability_scope: Option<ReachabilityScope>, pub has_global_address: bool, pub port_mapping_active: bool, pub port_mapping_addr: Option<SocketAddr>, pub mdns_browsing: bool, pub mdns_advertising: bool, pub mdns_discovered_peers: usize, pub relay_service_enabled: bool, pub coordinator_service_enabled: bool, pub bootstrap_service_enabled: bool, pub connected_peers: usize, pub active_connections: usize, pub pending_connections: usize, pub direct_connections: u64, pub relayed_connections: u64, pub hole_punch_success_rate: f64, pub is_relaying: bool, pub relay_sessions: usize, pub relay_bytes_forwarded: u64, pub is_coordinating: bool, pub coordination_sessions: usize, pub avg_rtt: Duration, pub uptime: Duration,
}
Expand description

Comprehensive node status snapshot

This struct provides a consolidated snapshot of the node’s current state, including identity, connectivity, NAT status, relay/coordinator hints, and performance.

§Status Categories

  • Identity: peer_id, local_addr, external_addrs
  • NAT Status: nat_type, can_receive_direct, direct_reachability_scope, has_global_address
  • Connections: connected_peers, active_connections, pending_connections
  • NAT Traversal: direct_connections, relayed_connections, hole_punch_success_rate
  • Assist Services: relay_service_enabled, coordinator_service_enabled, bootstrap_service_enabled
  • Relay Activity: is_relaying, relay_sessions, relay_bytes_forwarded
  • Coordinator Activity: is_coordinating, coordination_sessions
  • Performance: avg_rtt, uptime

Fields§

§peer_id: PeerId

This node’s peer ID (derived from public key)

§local_addr: SocketAddr

Local bind address

§external_addrs: Vec<SocketAddr>

All discovered external addresses

These are addresses as seen by other peers. Multiple addresses may be discovered when behind NAT or with multiple interfaces.

§nat_type: NatType

Best-effort NAT behavior hint.

This is observational telemetry derived from native QUIC reachability outcomes and address observations, not authoritative NAT classification.

§can_receive_direct: bool

Whether this node can receive direct connections

true only after this node has peer-verified evidence that another node reached it directly without coordinator or relay assistance.

§direct_reachability_scope: Option<ReachabilityScope>

Broadest scope in which direct inbound reachability has been verified.

§has_global_address: bool

Whether this node has a globally routable address candidate.

This is an address property, not proof of reachability.

§port_mapping_active: bool

Whether best-effort router port mapping is currently active.

§port_mapping_addr: Option<SocketAddr>

The currently mapped public address, if router port mapping is active.

§mdns_browsing: bool

Whether first-party mDNS browsing is currently active.

§mdns_advertising: bool

Whether first-party mDNS advertisement is currently active.

§mdns_discovered_peers: usize

Number of currently eligible peers surfaced by first-party mDNS.

§relay_service_enabled: bool

Whether this node offers relay service as a capability hint to peers.

This is a local policy/configuration signal. Remote peers still decide whether this node is actually useful for relay service.

§coordinator_service_enabled: bool

Whether this node offers coordinator capability as a hint to peers.

This is a capability advertisement, not proof of current reachability or performance.

§bootstrap_service_enabled: bool

Whether this node offers bootstrap/known-peer assist capability.

Peers may treat this node as one discovery/bootstrap input among many.

§connected_peers: usize

Number of connected peers

§active_connections: usize

Number of active connections (may differ from peers if multiplexed)

§pending_connections: usize

Number of pending connection attempts

§direct_connections: u64

Total successful direct connections (no relay)

§relayed_connections: u64

Total connections that required relay

§hole_punch_success_rate: f64

Hole punch success rate (0.0 - 1.0)

Calculated from NAT traversal attempts vs successes.

§is_relaying: bool

Whether this node is currently acting as a relay for others.

This tracks observed runtime activity, not merely whether the node is willing to offer relay service.

§relay_sessions: usize

Number of active relay sessions.

Currently reported conservatively; this is not yet a complete runtime metric.

§relay_bytes_forwarded: u64

Total bytes forwarded as relay

§is_coordinating: bool

Whether this node is coordinating NAT traversal.

This is a best-effort signal derived from observed coordination activity in the current process lifetime, not merely whether the node advertises coordinator capability.

§coordination_sessions: usize

Number of active coordination sessions.

This is currently a best-effort cumulative proxy derived from runtime coordination statistics rather than an authoritative live in-flight count.

§avg_rtt: Duration

Average round-trip time across all connections

§uptime: Duration

Time since node started

Implementations§

Source§

impl NodeStatus

Source

pub fn is_connected(&self) -> bool

Check if node has any connectivity

Source

pub fn can_help_traversal(&self) -> bool

Check if node can help with NAT traversal

Returns true if the node currently participates in the assist plane or has peer-verified direct reachability.

Source

pub fn total_connections(&self) -> u64

Get the total number of connections (direct + relayed)

Source

pub fn direct_rate(&self) -> f64

Get the direct connection rate (0.0 - 1.0)

Higher is better - indicates more direct connections vs relayed.

Trait Implementations§

Source§

impl Clone for NodeStatus

Source§

fn clone(&self) -> NodeStatus

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 NodeStatus

Source§

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

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

impl Default for NodeStatus

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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