Struct SshClient 

pub struct SshClient {
    pub session: Handle<ClientHandler>,
    /* private fields */
}

Available on crate feature ssh-real only.

Active SSH client with an authenticated session.

Fields

session: Handle<ClientHandler>

Authenticated SSH session for low-level operations.

Implementations

impl SshClient

pub async fn connect(cfg: ConnectionConfig) -> SshCliResult<Self>

Connects and authenticates. The full flow (TCP + handshake + auth) honors the configuration timeout_ms.

Errors

• SshCliError::InvalidArgument if the configuration is invalid.
• SshCliError::SshTimeout se exceder o timeout total.
• SshCliError::ConnectionFailed em falhas TCP/handshake.
• SshCliError::AuthenticationFailed se o servidor rejeitar password/key (tente --key, --password-stdin ou --key-passphrase-stdin).

pub async fn run_command( &mut self, command: &str, max_chars: usize, stdin_data: Option<Vec<u8>>, ) -> SshCliResult<ExecutionOutput>

Runs a remote shell command and captures stdout/stderr in parallel.

Trunca cada stream em max_chars codepoints UTF-8. Respeita o configuration timeout_ms for the entire execution.

Errors

• SshCliError::ChannelFailed em falha ao abrir channel ou enviar exec.
• SshCliError::SshTimeout se exceder o timeout.

pub async fn upload( &mut self, local: &Path, remote: &Path, ) -> SshCliResult<TransferResult>

Upload de file local para remote via SCP (protocolo OpenSSH sink).

One-shot: stream in chunks (without loading the whole file into RAM).

Errors

• SshCliError::FileNotFound if the local file does not exist.
• SshCliError::InvalidArgument if the local path is not a regular file.
• SshCliError::ChannelFailed em falha ao abrir channel SCP / status remoto.
• SshCliError::SshTimeout se exceder o timeout.

pub async fn download( &mut self, remote: &Path, local: &Path, ) -> SshCliResult<TransferResult>

Download de file remote para local via SCP (protocolo OpenSSH source).

Writes to {local}.ssh-cli.partial and renames atomically (SCP-022).

Errors

• SshCliError::Io if the local file cannot be written.
• SshCliError::ChannelFailed em falha ao abrir channel SCP / status remoto.
• SshCliError::SshTimeout se exceder o timeout.

pub async fn disconnect(&self) -> SshCliResult<()>

Cleanly closes the SSH session.

Errors

Propaga falha se disconnect retornar err do transporte.

pub async fn open_tunnel_channel( &self, remote_host: &str, remote_port: u16, endereco_origem: &str, porta_origem: u16, ) -> SshCliResult<Box<dyn TunnelChannel>>

Abre channel direct-tcpip para forwarding SSH.

Trait Implementations

impl Debug for SshClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl SshClientTrait for SshClient

fn connect<'async_trait>( cfg: ConnectionConfig, ) -> Pin<Box<dyn Future<Output = Result<Box<Self>, SshCliError>> + Send + 'async_trait>>

where Self: 'async_trait,

Connects to an SSH server and authenticates with the provided credentials.

fn run_command<'life0, 'life1, 'async_trait>( &'life0 mut self, cmd: &'life1 str, max_chars: usize, stdin_data: Option<Vec<u8>>, ) -> Pin<Box<dyn Future<Output = Result<ExecutionOutput, SshCliError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Runs a remote shell command and returns the captured output.

fn upload<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, local: &'life1 Path, remote: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<TransferResult, SshCliError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Faz upload de um file local para o servidor remoto via SCP.

fn download<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, remote: &'life1 Path, local: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<TransferResult, SshCliError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Faz download de um file remoto para o sistema local via SCP.

fn open_tunnel_channel<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, remote_host: &'life1 str, remote_port: u16, endereco_origem: &'life2 str, porta_origem: u16, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn TunnelChannel>, SshCliError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Abre um channel direct-tcpip para forwarding de tunnel.

fn disconnect<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), SshCliError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Cleanly closes the SSH connection.