Struct Node 

pub struct Node { /* private fields */ }

One node of one collective: its key, its store and an iroh endpoint.

Implementations

impl Node

pub async fn bind(place: &Place, addr: SocketAddr) -> Result<Node, String>

Opens the endpoint for place on addr — only after the gate, so a local collective or an off repo never even gets a socket.

pub async fn joining(place: &Place, addr: SocketAddr) -> Result<Node, String>

A node of a collective whose membership this machine does not hold yet: it can only join.

pub async fn open( place: &Place, addr: Option<SocketAddr>, member: bool, tweak: impl FnOnce(Builder) -> Builder, ) -> Result<Node, String>

The endpoint for the collective’s relay setting (addr.rs). addr is the UDP socket for direct paths (None: relay only, for tests); member: refuse without a membership; tweak adjusts the builder (tests trust a local relay’s self-signed certificate).

pub async fn online(&self, within: Duration) -> bool

Waits until the endpoint holds a connection to its home relay (at most within); true if it does. Nothing to wait for with relays disabled.

pub fn home_relay(&self) -> Option<String>

The relay this node is reachable through, once it is online.

pub fn hints(&self) -> Vec<Hint>

Where another machine could reach this node: its direct addresses (tickets) and its home relay. What serve writes to mesh/addr.json for invite to put in a ticket.

pub fn relay(&self) -> &Relay

pub fn quiet(self) -> Node

A node that only dials and exits (sync, fetch): it tells no peer where it listens, because its ephemeral port is gone a moment later.

pub fn gate(&self) -> Result<(String, PathBuf), String>

The gate again, on the config as it is now, and the store must still be the bound one.

pub fn home(&self) -> &Path

pub fn public(&self) -> String

pub fn ticket(&self) -> String

<key>@<ip:port>: what a peer passes to sync. The first of tickets.

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

One ticket per address another machine could dial. Bound to a specific IP that is the one; bound to an unspecified IP (0.0.0.0, the default) it is each interface address iroh found, never 0.0.0.0 itself (empty if there is none: then --bind IP:PORT).

pub fn enforce(&self) -> Result<usize, String>

Applies the held membership to the logs unless they were already checked against it (a join or revoke by another process, or a sync, changed it). Returns how many lines moved.

pub fn stamp(&self) -> Result<usize, String>

Stamps the lines this node’s hooks wrote since the last call as its own (Store::stamp).

pub async fn sync(&self, target: &str) -> Result<Report, String>

Dials the member named by target (<key>[@<hints>], addr.rs) and reconciles.

pub async fn fetch( &self, target: &str, commits: &[String], ) -> Result<Report, String>

sync, also asking the peer for the reasoning excerpts of commits (step 5): what it holds lands in this node’s reasoning.jsonl.

pub async fn join( &self, ticket: &Ticket, ) -> Result<(Membership, Report), String>

Joins with an invite ticket (invite.rs): dials the admin that issued it, presents the signed invite, installs the membership history it answers with (trusted because iroh authenticated the ticket’s admin key), remembers the admin as a peer and syncs with it at once.

pub async fn incoming(&self) -> Option<Incoming>

The next peer dialling in, None once the endpoint is closed.

pub async fn accept(&self) -> Result<Report, String>

Serves the next peer that dials in; returns what it moved, or why it was turned away.

pub async fn handle(&self, incoming: Incoming) -> Result<Report, String>

Serves one peer that dialled in.

pub async fn close(&self)