Struct Ssh 

pub struct Ssh { /* private fields */ }

Represents an ssh2 client.

Implementations

impl Ssh

pub fn connect(host: impl AsRef<str>, opts: SshOpts) -> Result<Self>

Connect to a remote TCP server using SSH.

pub fn host(&self) -> &str

Host this client is connected to.

pub fn port(&self) -> u16

Port this client is connected to on remote host.

pub fn is_authenticated(&self) -> bool

pub async fn authenticate(&mut self, handler: impl SshAuthHandler) -> Result<()>

Authenticates the Ssh if not already authenticated.

pub async fn detect_family(&self) -> Result<SshFamily>

Detects the family of operating system on the remote machine.

Caches the result such that subsequent checks will return the same family.

pub async fn launch_and_connect( self, opts: DistantLaunchOpts, ) -> Result<DistantClient>

Consume Ssh and produce a DistantClient that is connected to a remote distant server that is spawned using the ssh client

pub async fn launch( self, opts: DistantLaunchOpts, ) -> Result<DistantSingleKeyCredentials>

Consume Ssh and launch a distant server, returning a DistantSingleKeyCredentials tied to the launched server that includes credentials

pub async fn into_distant_client(self) -> Result<DistantClient>

Consume Ssh and produce a DistantClient that is powered by an ssh client underneath.

pub async fn into_distant_pair(self) -> Result<(DistantClient, ServerRef)>

Consumes Ssh and produces a DistantClient and ServerRef pair.