Struct radicle::node::Node

pub struct Node { /* private fields */ }

Node controller.

Implementations

impl Node

pub fn new<P: AsRef<Path>>(path: P) -> Self

Connect to the node, via the socket at the given path.

pub fn call<T: DeserializeOwned + Send + 'static>( &self, cmd: Command, timeout: Duration, ) -> Result<LineIter<T>, Error>

Call a command on the node.

pub fn announce( &mut self, rid: RepoId, seeds: impl IntoIterator<Item = NodeId>, timeout: Duration, callback: impl FnMut(AnnounceEvent, &HashMap<PublicKey, Duration>) -> ControlFlow<()>, ) -> Result<AnnounceResult, Error>

Announce refs of the given rid to the given seeds. Waits for the seeds to acknowledge the refs or times out if no acknowledgments are received within the given time.

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl Handle for Node

type Sessions = Vec<Session>

The peer sessions type.

type Events = LineIter<Event>

type Event = Result<Event, Error>

type Error = Error

The error returned by all methods.

fn nid(&self) -> Result<NodeId, Error>

Get the local Node ID.

fn listen_addrs(&self) -> Result<Vec<SocketAddr>, Error>

Get the node’s bound listen addresses.

fn is_running(&self) -> bool

Check if the node is running.

fn config(&self) -> Result<Config, Error>

Get the current node configuration.

fn connect( &mut self, nid: NodeId, addr: Address, opts: ConnectOptions, ) -> Result<ConnectResult, Error>

Connect to a peer.

fn disconnect(&mut self, nid: NodeId) -> Result<(), Self::Error>

Disconnect from a peer.

fn seeds(&mut self, rid: RepoId) -> Result<Seeds, Error>

Lookup the seeds of a given repository in the routing table.

fn fetch( &mut self, rid: RepoId, from: NodeId, timeout: Duration, ) -> Result<FetchResult, Error>

Fetch a repository from the network.

fn follow(&mut self, nid: NodeId, alias: Option<Alias>) -> Result<bool, Error>

Start following the given peer.

fn seed(&mut self, rid: RepoId, scope: Scope) -> Result<bool, Error>

Start seeding the given repo. May update the scope. Does nothing if the repo is already seeded.

fn unfollow(&mut self, nid: NodeId) -> Result<bool, Error>

Unfollow the given peer.

fn unseed(&mut self, rid: RepoId) -> Result<bool, Error>

Un-seed the given repo and delete it from storage.

fn announce_refs(&mut self, rid: RepoId) -> Result<RefsAt, Error>

Notify the service that a project has been updated, and announce local refs.

fn announce_inventory(&mut self) -> Result<(), Error>

Announce local inventory.

fn update_inventory(&mut self, rid: RepoId) -> Result<bool, Error>

Notify the service that our inventory was updated with the given repository.

fn subscribe(&self, timeout: Duration) -> Result<LineIter<Event>, Error>

Subscribe to node events.

fn sessions(&self) -> Result<Self::Sessions, Error>

Query the peer session state.

fn debug(&self) -> Result<Value, Self::Error>

Return debug information as a JSON value.

fn shutdown(self) -> Result<(), Error>

Ask the service to shutdown.