Struct NodeInfo

pub struct NodeInfo {
    pub node_id: NodeId,
    pub data: NodeData,
}

Information about a node that may be published to and resolved from discovery services.

This struct couples a NodeId with its associated NodeData.

Fields

node_id: NodeId

The NodeId of the node this is about.

data: NodeData

The information published about the node.

Implementations

impl NodeInfo

pub fn new(node_id: NodeId) -> Self

Creates a new NodeInfo with an empty NodeData.

pub fn from_parts(node_id: NodeId, data: NodeData) -> Self

Creates a new NodeInfo from its parts.

pub fn with_relay_url(self, relay_url: Option<RelayUrl>) -> Self

Sets the relay URL and returns the updated node info.

pub fn with_direct_addresses( self, direct_addresses: BTreeSet<SocketAddr>, ) -> Self

Sets the direct addresses and returns the updated node info.

pub fn with_user_data(self, user_data: Option<UserData>) -> Self

Sets the user-defined data and returns the updated node info.

pub fn to_node_addr(&self) -> NodeAddr

Converts into a NodeAddr by cloning the needed fields.

pub fn into_node_addr(self) -> NodeAddr

Converts into a NodeAddr without cloning.

pub fn from_txt_lookup(lookup: TxtLookup) -> Result<Self>

Available on non-wasm_browser only.

Parses a NodeInfo from a TXT records lookup.

pub fn from_pkarr_signed_packet(packet: &SignedPacket) -> Result<Self>

Parses a NodeInfo from a [pkarr::SignedPacket].

pub fn to_pkarr_signed_packet( &self, secret_key: &SecretKey, ttl: u32, ) -> Result<SignedPacket>

Creates a [pkarr::SignedPacket].

This constructs a DNS packet and signs it with a SecretKey.

pub fn to_txt_strings(&self) -> Vec<String>

Converts into a list of {key}={value} strings.

Methods from Deref<Target = NodeData>

pub fn relay_url(&self) -> Option<&RelayUrl>

Returns the relay URL of the node.

pub fn user_data(&self) -> Option<&UserData>

Returns the optional user-defined data of the node.

pub fn direct_addresses(&self) -> &BTreeSet<SocketAddr>

Returns the direct addresses of the node.

pub fn clear_direct_addresses(&mut self)

Removes all direct addresses from the node data.

pub fn add_direct_addresses( &mut self, addrs: impl IntoIterator<Item = SocketAddr>, )

Adds direct addresses to the node data.

pub fn set_relay_url(&mut self, relay_url: Option<RelayUrl>)

Sets the relay URL of the node data.

pub fn set_user_data(&mut self, user_data: Option<UserData>)

Sets the user-defined data of the node data.

Trait Implementations

impl Clone for NodeInfo

fn clone(&self) -> NodeInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeInfo

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

Formats the value using the given formatter.

impl Deref for NodeInfo

type Target = NodeData

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for NodeInfo

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<NodeAddr> for NodeInfo

fn from(addr: NodeAddr) -> Self

Converts to this type from the input type.

impl From<NodeInfo> for NodeAddr

fn from(value: NodeInfo) -> Self

Converts to this type from the input type.

impl PartialEq for NodeInfo

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

impl StructuralPartialEq for NodeInfo