Struct PassphraseArgs

pub struct PassphraseArgs {
    pub passphrase_path: Option<PathBuf>,
    pub insecure_passphrase: Option<SecretString>,
}

Clap arguments for passphrases.

use clap::Parser;
use miette::Result;
use algae_cli::passphrases::PassphraseArgs;

/// Your CLI tool
#[derive(Parser)]
struct Args {
    #[command(flatten)]
    pass: PassphraseArgs,
}

#[tokio::main]
async fn main() -> Result<()> {
    let args = Args::parse();
    let key = args.pass.require().await?;
    // use key somehow...
    Ok(())
}

Fields

passphrase_path: Option<PathBuf>

Path to a file containing a passphrase.

The contents of the file will be trimmed of whitespace.

insecure_passphrase: Option<SecretString>

A passphrase as a string.

This is extremely insecure, only use when there is no other option. When on an interactive terminal, make sure to wipe this command line from your history, or better yet not record it in the first place (in Bash you often can do that by prepending a space to your command).

Implementations

impl PassphraseArgs

pub async fn require(&self) -> Result<Passphrase>

Retrieve a passphrase from the user.

pub async fn require_with_confirmation(&self) -> Result<Passphrase>

Retrieve a passphrase from the user, with confirmation when prompting.

pub async fn require_phrase(&self) -> Result<SecretString>

Retrieve a passphrase from the user, as a SecretString.

pub async fn require_phrase_with_confirmation(&self) -> Result<SecretString>

Retrieve a passphrase from the user, as a SecretString, with confirmation when prompting.

Trait Implementations

impl Args for PassphraseArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

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

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

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

impl Clone for PassphraseArgs

fn clone(&self) -> PassphraseArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for PassphraseArgs

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 PassphraseArgs

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

Formats the value using the given formatter.

impl FromArgMatches for PassphraseArgs

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

fn parse() -> Self

Parse from std::env::args_os(), 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 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 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.