Struct SshAuthArgs 

pub struct SshAuthArgs {
    pub password: Option<String>,
    pub password_stdin: bool,
    pub key: Option<PathBuf>,
    pub key_passphrase: Option<String>,
    pub key_passphrase_stdin: bool,
    pub use_agent: bool,
    pub agent_socket: Option<PathBuf>,
}

Shared SSH authentication overrides (flatten into exec/scp/tunnel/health-check).

Converted to domain strings at the command boundary (G-08/G-09/G-24).

Fields

password: Option<String>

SSH password override.

password_stdin: bool

Reads the SSH password from stdin.

key: Option<PathBuf>

Private key path override.

key_passphrase: Option<String>

Key passphrase.

key_passphrase_stdin: bool

Reads the key passphrase from stdin.

use_agent: bool

Authenticate via ssh-agent (G-SSH-04). Requires --agent-socket on Unix.

agent_socket: Option<PathBuf>

Agent socket (Unix) or named pipe (Windows). CLI/XDG only — not env store.

Implementations

impl SshAuthArgs

pub fn key_path_string(&self) -> Option<String>

Domain boundary: PathBuf → owned path string for VPS/SSH layers.

Trait Implementations

impl Args for SshAuthArgs

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 SshAuthArgs

fn clone(&self) -> SshAuthArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SshAuthArgs

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

Formats the value using the given formatter.

impl Default for SshAuthArgs

fn default() -> SshAuthArgs

Returns the “default value” for a type.

impl FromArgMatches for SshAuthArgs

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.