Skip to main content

Command

Enum Command 

Source
pub enum Command {
Show 15 variants AnnounceRefs(RepoId, HashSet<PublicKey>, Responder<RefsAt>), AnnounceInventory, AddInventory(RepoId, Responder<bool>), Connect(NodeId, Address, ConnectOptions), Disconnect(NodeId), Config(Responder<Config>), ListenAddrs(Responder<Vec<SocketAddr>>), Seeds(RepoId, HashSet<PublicKey>, Responder<Seeds>), Fetch(RepoId, NodeId, Duration, Option<FeatureLevel>, Responder<FetchResult>), Seed(RepoId, Scope, Responder<bool>), Unseed(RepoId, Responder<bool>), Follow(NodeId, Option<Alias>, Responder<bool>), Unfollow(NodeId, Responder<bool>), Block(NodeId, Sender<bool>), QueryState(Arc<QueryState>, Sender<Result<()>>),
}
Expand description

Commands sent to the service by the operator.

Each variant has a corresponding helper constructor, e.g. Command::Seed and Command::seed. These constructors will hide the construction of the Responder, and return the corresponding Receiver to receive the result of the command process.

If the command does not return a Responder, then it will only return the Command variant, e.g. Command::AnnounceInventory.

Variants§

§

AnnounceRefs(RepoId, HashSet<PublicKey>, Responder<RefsAt>)

Announce repository references for given repository and namespaces to peers.

§

AnnounceInventory

Announce local repositories to peers.

§

AddInventory(RepoId, Responder<bool>)

Add repository to local inventory.

§

Connect(NodeId, Address, ConnectOptions)

Connect to node with the given address.

§

Disconnect(NodeId)

Disconnect from node.

§

Config(Responder<Config>)

Get the node configuration.

§

ListenAddrs(Responder<Vec<SocketAddr>>)

Get the node’s listen addresses.

§

Seeds(RepoId, HashSet<PublicKey>, Responder<Seeds>)

Lookup seeds for the given repository in the routing table, and report sync status for given namespaces.

§

Fetch(RepoId, NodeId, Duration, Option<FeatureLevel>, Responder<FetchResult>)

Fetch the given repository from the network.

§

Seed(RepoId, Scope, Responder<bool>)

Seed the given repository.

§

Unseed(RepoId, Responder<bool>)

Unseed the given repository.

§

Follow(NodeId, Option<Alias>, Responder<bool>)

Follow the given node.

§

Unfollow(NodeId, Responder<bool>)

Unfollow the given node.

§

Block(NodeId, Sender<bool>)

Block the given node.

§

QueryState(Arc<QueryState>, Sender<Result<()>>)

Query the internal service state.

Implementations§

Source§

impl Command

Source

pub fn announce_refs( rid: RepoId, keys: HashSet<PublicKey>, ) -> (Self, Receiver<Result<RefsAt>>)

Source

pub fn announce_inventory() -> Self

Source

pub fn add_inventory(rid: RepoId) -> (Self, Receiver<Result<bool>>)

Source

pub fn connect( node_id: NodeId, address: Address, options: ConnectOptions, ) -> Self

Source

pub fn disconnect(node_id: NodeId) -> Self

Source

pub fn config() -> (Self, Receiver<Result<Config>>)

Source

pub fn listen_addrs() -> (Self, Receiver<Result<Vec<SocketAddr>>>)

Source

pub fn seeds( rid: RepoId, keys: HashSet<PublicKey>, ) -> (Self, Receiver<Result<Seeds>>)

Source

pub fn fetch( rid: RepoId, node_id: NodeId, duration: Duration, signed_references_minimum_feature_level: Option<FeatureLevel>, ) -> (Self, Receiver<Result<FetchResult>>)

Source

pub fn seed(rid: RepoId, scope: Scope) -> (Self, Receiver<Result<bool>>)

Source

pub fn unseed(rid: RepoId) -> (Self, Receiver<Result<bool>>)

Source

pub fn follow( node_id: NodeId, alias: Option<Alias>, ) -> (Self, Receiver<Result<bool>>)

Source

pub fn unfollow(node_id: NodeId) -> (Self, Receiver<Result<bool>>)

Source

pub fn query_state(state: Arc<QueryState>, sender: Sender<Result<()>>) -> Self

Trait Implementations§

Source§

impl Debug for Command

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V