Enum iroh_docs::cli::authors::AuthorCommands

pub enum AuthorCommands {
    Switch {
        author: AuthorId,
    },
    Create {
        switch: bool,
    },
    Delete {
        author: AuthorId,
    },
    Export {
        author: AuthorId,
    },
    Import {
        author: String,
    },
    Default {
        switch: bool,
    },
    List,
}

Available on crate feature cli only.

Commands to manage authors.

Variants

Switch

Set the active author (Note: only works within the Iroh console).

Fields

author: AuthorId

Create

Create a new author.

Fields

switch: bool

Switch to the created author (Note: only works in the Iroh console).

Delete

Delete an author.

Fields

author: AuthorId

Export

Export an author.

Fields

author: AuthorId

Import

Import an author.

Fields

author: String

Default

Print the default author for this node.

Fields

switch: bool

Switch to the default author (Note: only works in the Iroh console).

List

List authors.

Implementations

impl AuthorCommands

pub async fn run(self, authors: &Client, env: &ConsoleEnv) -> Result<()>

Runs the author command given an iroh client and console environment.

Trait Implementations

impl Clone for AuthorCommands

fn clone(&self) -> AuthorCommands

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for AuthorCommands

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for AuthorCommands

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

Formats the value using the given formatter.

impl FromArgMatches for AuthorCommands

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 Parser for AuthorCommands

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Subcommand for AuthorCommands

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