Struct NodeData

pub struct NodeData { /* private fields */ }

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

This includes an optional RelayUrl, a set of direct addresses, and the optional UserData, a string that can be set by applications and is not parsed or used by iroh itself.

This struct does not include the node’s NodeId, only the data about a certain node. See NodeInfo for a struct that contains a NodeId with associated NodeData.

Implementations

impl NodeData

pub fn new( relay_url: Option<RelayUrl>, direct_addresses: BTreeSet<SocketAddr>, ) -> Self

Creates a new NodeData with a relay URL and a set of direct addresses.

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

Sets the relay URL and returns the updated node data.

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

Sets the direct addresses and returns the updated node data.

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

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

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 NodeData

fn clone(&self) -> NodeData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeData

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

Formats the value using the given formatter.

impl Default for NodeData

fn default() -> NodeData

Returns the “default value” for a type.

impl From<NodeAddr> for NodeData

fn from(node_addr: NodeAddr) -> Self

Converts to this type from the input type.

impl PartialEq for NodeData

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

impl StructuralPartialEq for NodeData