Struct SshOpts 

pub struct SshOpts { /* private fields */ }

Ssh options; used to build and configure SCP/SFTP client.

Conflict resolution

You may specify some options that can be in conflict (e.g. port and Port parameter in ssh configuration). In these cases, the resolution is performed in this order (from highest, to lower priority):

1. SshOpts attribute (e.g. port or username)
2. Ssh configuration

This applies also to ciphers and key exchange methods.

Implementations

impl SshOpts

pub fn new<S: AsRef<str>>(host: S) -> Self

Initialize SshOpts. You must define the host you want to connect to. Host may be resolved by ssh configuration, if specified.

Other options can be specified with other constructors.

pub fn port(self, port: u16) -> Self

Specify the port the remote server is listening to. This option will override an eventual port specified for the current host in the ssh configuration

pub fn username<S: AsRef<str>>(self, username: S) -> Self

Set username to log in as This option will override an eventual username specified for the current host in the ssh configuration

pub fn password<S: AsRef<str>>(self, password: S) -> Self

Set password to authenticate with

pub fn connection_timeout(self, timeout: Duration) -> Self

Set connection timeout This option will override an eventual connection timeout specified for the current host in the ssh configuration

pub fn ssh_agent_identity( self, ssh_agent_identity: Option<SshAgentIdentity>, ) -> Self

Set configuration for ssh agent

If None the ssh agent will be disabled

If Some(SshAgentIdentity::All) all identities will be tried Otherwise the provided public key will be used

pub fn config_file<P: AsRef<Path>>(self, p: P, rules: ParseRule) -> Self

Set SSH configuration file to read

The supported options are:

• Host block
• HostName
• Port
• User
• Ciphers
• MACs
• KexAlgorithms
• HostKeyAlgorithms
• ConnectionAttempts
• ConnectTimeout

pub fn key_storage(self, storage: Box<dyn SshKeyStorage>) -> Self

Set key storage to read RSA keys from

pub fn method(self, method: KeyMethod) -> Self

Add key method to ssh options

Trait Implementations

impl From<SshOpts> for ScpFs<LibSsh2Session>

fn from(opts: SshOpts) -> Self

Converts to this type from the input type.

impl From<SshOpts> for ScpFs<LibSshSession>

fn from(opts: SshOpts) -> Self

Converts to this type from the input type.

impl From<SshOpts> for SftpFs<LibSsh2Session>

fn from(opts: SshOpts) -> Self

Converts to this type from the input type.

impl From<SshOpts> for SftpFs<LibSshSession>

fn from(opts: SshOpts) -> Self

Converts to this type from the input type.