Struct SessionBuilder

pub struct SessionBuilder { /* private fields */ }

Implementations

impl SessionBuilder

pub fn new() -> Self

pub fn disable_default() -> Self

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

Read/Write timeout for local SSH mode. Use None to disable timeout. This is a global timeout only take effect after the session is established

Use connect_with_timeout instead if you want to add timeout when connect to the target SSH server

pub fn username(self, username: &str) -> Self

pub fn password(self, password: &str) -> Self

pub fn private_key<K>(self, private_key: K) -> Self

where K: ToString,

pub fn private_key_path<P>(self, key_path: P) -> Self

where P: AsRef<Path>,

pub fn add_kex_algorithms(self, alg: Kex) -> Self

pub fn del_kex_algorithms(self, alg: Kex) -> Self

pub fn add_pubkey_algorithms(self, alg: PubKey) -> Self

pub fn del_pubkey_algorithms(self, alg: PubKey) -> Self

pub fn add_enc_algorithms(self, alg: Enc) -> Self

pub fn del_enc_algorithms(self, alg: Enc) -> Self

pub fn add_mac_algortihms(self, alg: Mac) -> Self

pub fn del_mac_algortihms(self, alg: Mac) -> Self

pub fn add_compress_algorithms(self, alg: Compress) -> Self

pub fn del_compress_algorithms(self, alg: Compress) -> Self

pub fn connect<A>(self, addr: A) -> SshResult<SessionConnector<TcpStream>>

where A: ToSocketAddrs,

Create a TCP connection to the target server

pub fn connect_with_timeout<A>( self, addr: A, timeout: Option<Duration>, ) -> SshResult<SessionConnector<TcpStream>>

where A: ToSocketAddrs,

Create a TCP connection to the target server, with timeout provided

pub fn connect_bio<S>(self, stream: S) -> SshResult<SessionConnector<S>>

where S: Read + Write,

connect to target server w/ a bio object

which requires to implement std::io::{Read, Write}

Trait Implementations

impl Default for SessionBuilder

fn default() -> SessionBuilder

Returns the “default value” for a type.