Struct bonsaidb::cli::Args

pub struct Args<Cli: CommandLine> {
    pub url: Option<Url>,
    pub pinned_certificate: Option<PathBuf>,
    pub token_id: Option<u64>,
    pub username: Option<String>,
    pub command: Command<Cli>,
}

The command line interface for bonsaidb.

Fields

url: Option<Url>

A url to a remote server.

pinned_certificate: Option<PathBuf>

A pinned certificate to use when connecting to url.

token_id: Option<u64>

A token ID to authenticate as before executing the command. Use environment variable BONSAIDB_TOKEN_SECRET to provide the

username: Option<String>

A user to authenticate as before executing the command. The password will be prompted for over stdin. When writing a script for headless automation, token authentication should be preferred.

command: Command<Cli>

The command to execute on the connection specified.

Implementations

impl<Cli: CommandLine> Args<Cli>

pub async fn execute(self, cli: Cli) -> Result<()>

Executes the command.

Trait Implementations

impl<Cli: CommandLine> Args for Args<Cli>

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

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

Append to [Command] so it can instantiate Self.

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

Append to [Command] so it can update self.

impl<Cli: CommandLine> CommandFactory for Args<Cli>

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<Cli: Debug + CommandLine> Debug for Args<Cli>

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

Formats the value using the given formatter.

impl<Cli: CommandLine> FromArgMatches for Args<Cli>

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( &mut self, __clap_arg_matches: &mut ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl<Cli: CommandLine> Parser for Args<Cli>

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.