Struct SSHClient

pub struct SSHClient<'a> { /* private fields */ }

An async SSH client instance

The run() method runs the session to completion. progress() must be polled, and responses given to the events provided.

Once authentication has completed (progress() returns CliEvent::Authenticated), the application may open remote channels with open_session_pty() etc.

This is async executor agnostic.

Implementations

impl<'a> SSHClient<'a>

pub fn new(inbuf: &'a mut [u8], outbuf: &'a mut [u8]) -> Self

pub async fn run( &self, rsock: &mut impl Read, wsock: &mut impl Write, ) -> Result<()>

Runs the session to completion.

rsock and wsock are the SSH network channel (TCP port 22 or equivalent).

pub async fn progress<'g, 'f>( &'g self, ph: &'f mut ProgressHolder<'g, 'a, Client>, ) -> Result<CliEvent<'f, 'a>>

Returns an event from the SSH session.

Note that on return ProgressHolder holds a mutex over the session, so other calls to SSHClient may block until the ProgressHolder is dropped.

pub async fn open_session_nopty(&self) -> Result<(ChanInOut<'_>, ChanIn<'_>)>

pub async fn open_session_pty(&self) -> Result<ChanInOut<'_>>