Struct distant_ssh2::Ssh2Session

pub struct Ssh2Session { /* fields omitted */ }

Represents an ssh2 session

Implementations

impl Ssh2Session

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

Connect to a remote TCP server using SSH

pub fn host(&self) -> &str

Host this session is connected to

pub fn port(&self) -> u16

Port this session is connected to on remote host

pub fn is_authenticated(&self) -> bool

pub async fn authenticate(&mut self, handler: Ssh2AuthHandler<'_>) -> Result<()>

Authenticates the Ssh2Session if not already authenticated

pub async fn into_distant_session(
    self,
    opts: IntoDistantSessionOpts
) -> Result<Session>

Consume Ssh2Session and produce a distant Session that is connected to a remote distant server that is spawned using the ssh session

pub async fn into_ssh_client_session(self) -> Result<Session>

Consume Ssh2Session and produce a distant Session that is powered by an ssh client underneath