Struct SshClient 

pub struct SshClient { /* private fields */ }

Core SSH client structure

Implementations

impl SshClient

pub async fn connect_and_execute( &mut self, command: &str, key_path: Option<&Path>, use_agent: bool, ) -> Result<CommandResult>

Execute a command on the remote host with basic configuration

pub async fn connect_and_execute_with_host_check( &mut self, command: &str, key_path: Option<&Path>, strict_mode: Option<StrictHostKeyChecking>, use_agent: bool, use_password: bool, timeout_seconds: Option<u64>, ) -> Result<CommandResult>

Execute a command with host key checking configuration

pub async fn connect_and_execute_with_jump_hosts( &mut self, command: &str, config: &ConnectionConfig<'_>, ) -> Result<CommandResult>

Execute a command with full configuration including jump hosts

pub async fn connect_and_execute_with_output_streaming( &mut self, command: &str, config: &ConnectionConfig<'_>, output_sender: Sender<CommandOutput>, ) -> Result<u32>

Execute a command with streaming output support

This method provides real-time command output streaming through the provided sender channel. Output is sent as CommandOutput::StdOut or CommandOutput::StdErr variants.

Arguments

• command - The command to execute
• config - Connection configuration
• output_sender - Channel sender for streaming output

Returns

The exit status of the command

pub async fn connect_and_execute_with_sudo( &mut self, command: &str, config: &ConnectionConfig<'_>, output_sender: Sender<CommandOutput>, sudo_password: &SudoPassword, ) -> Result<u32>

Execute a command with sudo password support and streaming output.

This method handles automatic sudo password injection when sudo prompts are detected in the command output.

Arguments

• command - The command to execute (typically uses sudo)
• config - Connection configuration
• output_sender - Channel sender for streaming output
• sudo_password - The sudo password to inject when prompted

Returns

The exit status of the command

impl SshClient

pub fn new(host: String, port: u16, username: String) -> Self

Creates a new SSH client instance

impl SshClient

pub async fn upload_file( &mut self, local_path: &Path, remote_path: &str, key_path: Option<&Path>, strict_mode: Option<StrictHostKeyChecking>, use_agent: bool, use_password: bool, ) -> Result<()>

Upload a single file to the remote host

pub async fn download_file( &mut self, remote_path: &str, local_path: &Path, key_path: Option<&Path>, strict_mode: Option<StrictHostKeyChecking>, use_agent: bool, use_password: bool, ) -> Result<()>

Download a single file from the remote host

pub async fn upload_dir( &mut self, local_dir_path: &Path, remote_dir_path: &str, key_path: Option<&Path>, strict_mode: Option<StrictHostKeyChecking>, use_agent: bool, use_password: bool, ) -> Result<()>

Upload a directory to the remote host

pub async fn download_dir( &mut self, remote_dir_path: &str, local_dir_path: &Path, key_path: Option<&Path>, strict_mode: Option<StrictHostKeyChecking>, use_agent: bool, use_password: bool, ) -> Result<()>

Download a directory from the remote host

pub async fn upload_file_with_jump_hosts( &mut self, local_path: &Path, remote_path: &str, key_path: Option<&Path>, strict_mode: Option<StrictHostKeyChecking>, use_agent: bool, use_password: bool, jump_hosts_spec: Option<&str>, ) -> Result<()>

Upload file with jump host support

pub async fn download_file_with_jump_hosts( &mut self, remote_path: &str, local_path: &Path, key_path: Option<&Path>, strict_mode: Option<StrictHostKeyChecking>, use_agent: bool, use_password: bool, jump_hosts_spec: Option<&str>, ) -> Result<()>

Download file with jump host support

pub async fn upload_dir_with_jump_hosts( &mut self, local_dir_path: &Path, remote_dir_path: &str, key_path: Option<&Path>, strict_mode: Option<StrictHostKeyChecking>, use_agent: bool, use_password: bool, jump_hosts_spec: Option<&str>, ) -> Result<()>

Upload directory with jump host support

pub async fn download_dir_with_jump_hosts( &mut self, remote_dir_path: &str, local_dir_path: &Path, key_path: Option<&Path>, strict_mode: Option<StrictHostKeyChecking>, use_agent: bool, use_password: bool, jump_hosts_spec: Option<&str>, ) -> Result<()>

Download directory with jump host support