Struct distant_ssh2::SshOpts

pub struct SshOpts {
    pub backend: SshBackend,
    pub identity_files: Vec<PathBuf>,
    pub identities_only: Option<bool>,
    pub port: Option<u16>,
    pub proxy_command: Option<String>,
    pub user: Option<String>,
    pub user_known_hosts_files: Vec<PathBuf>,
    pub verbose: bool,
    pub other: BTreeMap<String, String>,
}

Represents options to be provided when establishing an ssh client

Fields

backend: SshBackend

Represents the backend to use for ssh operations

identity_files: Vec<PathBuf>

List of files from which the user’s DSA, ECDSA, Ed25519, or RSA authentication identity is read, defaulting to

• ~/.ssh/id_dsa
• ~/.ssh/id_ecdsa
• ~/.ssh/id_ed25519
• ~/.ssh/id_rsa

identities_only: Option<bool>

If provided and true, specifies that ssh should only use the configured authentication and certificate files (either the defaults or configured from identity_files)

Default is false (aka no)

port: Option<u16>

Port to use when connecting to an SSHD instance

proxy_command: Option<String>

Specifies the command to use to connect to the server

user: Option<String>

Specifies the user to log in as

user_known_hosts_files: Vec<PathBuf>

Specifies one or more files to use for the user host key database, defaulting to

• ~/.ssh/known_hosts
• ~/.ssh/known_hosts2

verbose: bool

If true, will output tracing information from the underlying ssh implementation

other: BTreeMap<String, String>

Additional options to provide as defined by ssh_config(5)

Trait Implementations

impl Clone for SshOpts

fn clone(&self) -> SshOpts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SshOpts

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

Formats the value using the given formatter.

impl Default for SshOpts

fn default() -> SshOpts

Returns the “default value” for a type.