Skip to main content

SshSession

Struct SshSession 

Source
pub struct SshSession {
    pub host: HostSpec,
    pub env: SshEnv,
    pub config_file: Option<PathBuf>,
}
Expand description

SSH destination plus askpass policy.

Fields§

§host: HostSpec

OpenSSH Host or user@host.

§env: SshEnv

Askpass / env policy.

§config_file: Option<PathBuf>

Optional ssh -F / scp -F config file (tests / non-default layouts).

Implementations§

Source§

impl SshSession

Source

fn with_config_prefix(&self, rest: &[&str]) -> Vec<String>

Source

fn pubkey_already_authorized( &self, runner: &dyn ProcessRunner, pub_path: &Path, ) -> Result<bool>

True when BatchMode SSH with this identity already succeeds (key is on the box).

Source

pub fn exec( &self, runner: &dyn ProcessRunner, remote_cmd: &str, stdio: StdioMode, ) -> Result<CommandOutput>

Run a remote shell command via ssh.

Probes use StdioMode::Capture (no TTY). Interactive apply uses StdioMode::Inherit with ssh -tt so remote sudo can prompt.

§Errors

Returns crate::HortoError::CommandFailed when ssh exits non-zero.

Source

pub fn exec_stdin( &self, runner: &dyn ProcessRunner, remote_cmd: &str, stdin: &[u8], ) -> Result<CommandOutput>

Run a remote command with bytes on SSH stdin (no remote TTY).

§Errors

Returns crate::HortoError::CommandFailed when ssh exits non-zero.

Source

pub fn exec_stdin_reboot( &self, runner: &dyn ProcessRunner, remote_cmd: &str, stdin: &[u8], ) -> Result<CommandOutput>

Like Self::exec_stdin, with short SSH keepalives (box reboot / host drop).

§Errors

Returns crate::HortoError::CommandFailed when ssh exits non-zero.

Source

fn exec_stdin_inner( &self, runner: &dyn ProcessRunner, remote_cmd: &str, stdin: &[u8], reboot_timeouts: bool, ) -> Result<CommandOutput>

Source

pub fn scp_to( &self, runner: &dyn ProcessRunner, local: &Path, remote_path: &str, ) -> Result<()>

Copy a local file to a remote path with scp.

§Errors

Returns crate::HortoError when paths are invalid or scp fails.

Source

pub fn install_ssh_key(&self, runner: &dyn ProcessRunner) -> Result<()>

Opt-in: install the default identity pubkey on the box via ssh-copy-id -i.

Skips ssh-copy-id when BatchMode SSH with that identity already works (key already authorized). Without -i, ssh-copy-id would install every agent key; we always pass a single .pub.

§Errors

Returns crate::HortoError when no default pubkey exists or ssh-copy-id fails.

Source

pub fn remote_has_rsync(&self, runner: &dyn ProcessRunner) -> bool

Probe whether rsync exists on the remote host.

Trait Implementations§

Source§

impl Clone for SshSession

Source§

fn clone(&self) -> SshSession

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SshSession

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more