Enum GossipCommands

pub enum GossipCommands {
    Subscribe {
        topic: Option<String>,
        raw_topic: Option<String>,
        bootstrap: Vec<String>,
        verbose: bool,
    },
}

Available on crate feature cli only.

Commands to manage gossiping.

Variants

Subscribe

Subscribe to a gossip topic

Fields

topic: Option<String>

The topic to subscribe to.

This will be hashed with BLAKE3 to get the actual topic ID.

raw_topic: Option<String>

The raw topic to subscribe to as hex. Needs to be 32 bytes, i.e. 64 hex characters.

bootstrap: Vec<String>

The set of nodes that are also part of the gossip swarm to bootstrap with.

If empty, this will bootstrap a new swarm. Running the command will print the node’s NodeId, which can be used as the bootstrap argument in other nodes.

verbose: bool

If enabled, all gossip events will be printed, including neighbor up/down events.

Implementations

impl GossipCommands

pub async fn run(self, gossip: &Client) -> Result<()>

Runs the gossip command given the iroh client.

Trait Implementations

impl Clone for GossipCommands

fn clone(&self) -> GossipCommands

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GossipCommands

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

Formats the value using the given formatter.

impl FromArgMatches for GossipCommands

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for GossipCommands

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand