Struct SSHClient 

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

An async SSH client instance

The run() method runs the session to completion, with application behaviour defined by the CliBehaviour instance.

Once authentication has completed (authenticated() is called), the application may open remote channels with open_session_pty() etc.

This is async executor agnostic, though requires the CliBehaviour instance to be wrapped in a SunsetMutex.

Implementations

impl<'a> SSHClient<'a>

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

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

Runs the session to completion.

rsock and wsock are the SSH network channel (TCP port 22 or equivalent). b is an instance of CliBehaviour which defines application behaviour.

pub async fn exit(&self)

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

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