Struct openssh::SessionBuilder

pub struct SessionBuilder { /* fields omitted */ }

Build a Session with options.

Implementations

impl SessionBuilder

pub fn user(&mut self, user: String) -> &mut Self

Set the ssh user (ssh -l).

Defaults to None.

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

Set the port to connect on (ssh -p).

Defaults to None.

pub fn keyfile(&mut self, p: impl AsRef<Path>) -> &mut Self

Set the keyfile to use (ssh -i).

Defaults to None.

pub fn known_hosts_check(&mut self, k: KnownHosts) -> &mut Self

See KnownHosts.

Default KnownHosts::Add.

pub fn connect_timeout(&mut self, d: Duration) -> &mut Self

Set the connection timeout (ssh -o ConnectTimeout).

This value is specified in seconds. Any sub-second duration remainder will be ignored. Defaults to None.

pub fn server_alive_interval(&mut self, d: Duration) -> &mut Self

Set the timeout interval after which if no data has been received from the server, ssh will request a response from the server (ssh -o ServerAliveInterval).

This value is specified in seconds. Any sub-second duration remainder will be ignored. Defaults to None.

pub fn control_directory(&mut self, p: impl AsRef<Path>) -> &mut Self

Set the directory in which the temporary directory containing the control socket will be created.

If not set, ./ will be used (the current directory).

pub fn config_file(&mut self, p: impl AsRef<Path>) -> &mut Self

Set an alternative per-user configuration file.

By default, ssh uses ~/.ssh/config. This is equivalent to ssh -F <p>.

Defaults to None.

pub async fn connect<S: AsRef<str>>(
    &self,
    destination: S
) -> Result<Session, Error>

Connect to the host at the given host over SSH.

The format of destination is the same as the destination argument to ssh. It may be specified as either [user@]hostname or a URI of the form ssh://[user@]hostname[:port]. A username or port that is specified in the connection string overrides the one set in the builder (but does not change the builder).

If connecting requires interactive authentication based on STDIN (such as reading a password), the connection will fail. Consider setting up keypair-based authentication instead.

Trait Implementations

impl Clone for SessionBuilder

fn clone(&self) -> SessionBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SessionBuilder

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

Formats the value using the given formatter.

impl Default for SessionBuilder

fn default() -> Self

Returns the “default value” for a type.