Struct HostSsh 

pub struct HostSsh {
    pub dest: SshDest,
    pub ssh_path: PathBuf,
    pub control_dir: Option<PathBuf>,
    pub env: Vec<(String, String)>,
}

Fields

dest: SshDest

ssh_path: PathBuf

control_dir: Option<PathBuf>

ssh’s connection-sharing directory (macOS and Linux), if any.

env: Vec<(String, String)>

Set on ssh after the sanitizing: askpass (Self::ask_user_in).

Implementations

impl HostSsh

pub fn for_connection(conn: &str) -> Result<Self, String>

The host of an SSH connection name, with this machine’s ssh.

pub fn ask_user_in( &mut self, block_id: &str, conn: &str, auth_key: &str, ) -> Option<Revoke>

Send ssh’s prompts (a password, a passphrase, a new host key) to the user, in the window of their pane block_id, through the askpass bridge: this ssh has no terminal to ask in. The grant lasts until the returned guard is dropped. Nothing changes without the askpass helper; a login that needs a prompt then fails with ssh’s reason.

pub fn command(&self, remote: &str) -> Command

ssh -T ... -- <host> <remote>: no terminal on the remote side (frames or a script’s output, not a session, go over it). The caller sets its stdio.

fn ssh(&self, args: &[String]) -> Command

ssh with args, sanitized like every process srv starts, and askpass’s variables after the sanitizing (it needs srv’s address and key). Killed if dropped.

pub async fn shared_connection_up(&self) -> Option<bool>

Whether this host’s shared connection is up, which it is only once the user has logged in (ssh -O check). None where ssh doesn’t share connections (Windows), or ssh couldn’t be asked: nothing is known.

pub async fn close_shared_connection(&self)

Close this host’s shared connection (ssh -O exit): every session on it ends. Nothing to do where there is none, or ssh doesn’t share connections.

async fn run_control(&self, args: &[String]) -> Option<Output>

An ssh -O request: a local socket, answered at once, so a few seconds is plenty; None if ssh couldn’t run or didn’t answer.

pub async fn run( &self, remote: &str, input: Option<Vec<u8>>, limit: Duration, ) -> Result<HostOutput, String>

Run remote with input on its stdin, for at most limit, so a host that stops answering never holds the caller.

Trait Implementations

impl Clone for HostSsh

fn clone(&self) -> HostSsh

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HostSsh

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

Formats the value using the given formatter.