Struct Client

pub struct Client { /* private fields */ }

Iroh net Client.

Cheaply clonable and threadsafe. Use the iroh net::Client to access the iroh net methods from a different thread, process, or remote machine.

The node::Client api allows you to get information about the iroh node, its status, and connection status to other nodes. It also allows you to provide address information about other nodes to your node.

Implementations

impl Client

pub fn new(rpc: RpcClient<RpcService>) -> Self

Creates a new net client

pub async fn remote_info_iter( &self, ) -> Result<impl Stream<Item = Result<RemoteInfo>>>

Fetches information about currently known remote nodes.

This streams a current snapshot. It does not keep the stream open after finishing transferring the snapshot.

See also Endpoint::remote_info_iter.

pub async fn remote_info(&self, node_id: NodeId) -> Result<Option<RemoteInfo>>

Fetches node information about a remote iroh node identified by its NodeId.

See also Endpoint::remote_info.

pub async fn node_id(&self) -> Result<NodeId>

Fetches the node id of this node.

See also Endpoint::node_id.

pub async fn node_addr(&self) -> Result<NodeAddr>

Fetches the NodeAddr for this node.

See also Endpoint::node_addr.

pub async fn add_node_addr(&self, addr: NodeAddr) -> Result<()>

Adds a known node address to this node.

See also Endpoint::add_node_addr.

pub async fn home_relay(&self) -> Result<Option<RelayUrl>>

Returns the relay server we are connected to.

See also Endpoint::home_relay.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.