Struct SshTransport 

pub struct SshTransport { /* private fields */ }

SSH transport: executes commands and file operations on a remote host via the system ssh binary.

Host format

• user@host — default SSH port (22)
• user@host:port — custom port

Auth

By default uses ssh-agent or ~/.ssh/id_* keys. Optionally specify a private key path via key_path.

Implementations

impl SshTransport

pub fn new( host: impl Into<String>, remote_workspace: impl Into<PathBuf>, ) -> Self

Create a new SSH transport.

host is in user@host or user@host:port format. remote_workspace is the absolute path to the workspace on the remote machine.

pub fn with_key(self, key_path: impl Into<PathBuf>) -> Self

Set the path to an SSH private key.

pub fn with_connect_timeout(self, timeout: Duration) -> Self

Set the SSH connect timeout.

pub fn with_command_timeout(self, timeout: Duration) -> Self

Set the SSH command timeout.

pub fn host(&self) -> &str

Return the host string.

pub fn key_path(&self) -> Option<&Path>

Return the key path, if set.

pub fn remote_workspace(&self) -> &Path

Return the remote workspace path.

Trait Implementations

impl Clone for SshTransport

fn clone(&self) -> SshTransport

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SshTransport

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

Formats the value using the given formatter.

impl ToolTransport for SshTransport

fn read_file<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>>> + Send + 'async_trait>>

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

Read the full contents of a file at path.

fn write_file<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 Path, contents: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Write contents to a file at path, creating parent directories.

fn list_dir<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<DirEntry>>> + Send + 'async_trait>>

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

List entries in a directory at path.

fn create_dir_all<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Create a directory and all parents.

fn exec_shell<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, command: &'life1 str, cwd: &'life2 Path, env: &'life3 [(String, String)], timeout: Duration, max_output_bytes: usize, ) -> Pin<Box<dyn Future<Output = Result<ExecResult>> + Send + 'async_trait>>

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

Execute a shell command in the given working directory with optional environment variables, timeout, and max output bytes.