Struct StaticProvider

pub struct StaticProvider { /* private fields */ }

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

A static discovery implementation that allows providing info for nodes manually.

Implementations

impl StaticProvider

pub const PROVENANCE: &'static str = "static_discovery"

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

The provenance string for this discovery implementation.

pub fn new() -> Self

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Create a new static discovery instance.

pub fn from_node_addrs( infos: impl IntoIterator<Item = impl Into<NodeAddr>>, ) -> Self

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Creates a static discovery instance from something that can be converted into node addresses.

Example:

use std::str::FromStr;

use iroh_base::ticket::NodeTicket;
use iroh_net::{Endpoint, discovery::static_provider::StaticProvider};

// get tickets from command line args
let tickets: Vec<NodeTicket> = args.tickets;
// create a StaticProvider from the tickets. Ticket info will be combined if multiple tickets refer to the same node.
let discovery = StaticProvider::from_node_addrs(tickets);
// create an endpoint with the discovery
let endpoint = Endpoint::builder()
    .add_discovery(|_| Some(discovery))
    .bind().await?;

pub fn set_node_addr(&self, info: impl Into<NodeAddr>) -> Option<NodeAddr>

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Add node info for the given node id.

This will completely overwrite any existing info for the node.

pub fn add_node_addr(&self, info: impl Into<NodeAddr>)

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Add node info for the given node id, combining it with any existing info.

This will add any new direct addresses and overwrite the relay url.

pub fn get_node_addr(&self, node_id: NodeId) -> Option<NodeAddr>

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Get node info for the given node id.

pub fn remove_node_addr(&self, node_id: NodeId) -> Option<NodeAddr>

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Remove node info for the given node id.

Trait Implementations

impl Debug for StaticProvider

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

Formats the value using the given formatter.

impl Default for StaticProvider

fn default() -> StaticProvider

Returns the “default value” for a type.

impl Discovery for StaticProvider

fn publish(&self, _info: &AddrInfo)

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Publishes the given AddrInfo to the discovery mechanism.

fn resolve( &self, _endpoint: Endpoint, node_id: NodeId, ) -> Option<Boxed<Result<DiscoveryItem>>>

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Resolves the AddrInfo for the given NodeId.

fn subscribe(&self) -> Option<BoxStream<DiscoveryItem>>

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Subscribe to all addresses that get passively discovered.