Skip to main content

SshOptions

Struct SshOptions 

Source
pub struct SshOptions {
Show 14 fields pub ssh_path: String, pub scp_path: String, pub user: Option<String>, pub options: Vec<String>, pub connect_timeout: Option<u32>, pub strict_host_key_checking: bool, pub password_auth: bool, pub identity_file: Option<String>, pub config_file: Option<String>, pub control_master: Option<ControlMaster>, pub control_path: Option<String>, pub control_persist: Option<String>, pub proxy_jump: Option<String>, pub port: Option<u16>,
}
Expand description

SSH connection options.

Fields§

§ssh_path: String

Path to the SSH binary.

§scp_path: String

Path to the SCP binary.

§user: Option<String>

SSH user (if different from current user).

§options: Vec<String>

Custom SSH options (passed as -o key=value).

§connect_timeout: Option<u32>

Connect timeout in seconds.

§strict_host_key_checking: bool

Whether to use strict host key checking.

§password_auth: bool

Whether to enable password authentication.

§identity_file: Option<String>

Path to SSH identity file (passed as -i).

§config_file: Option<String>

Path to SSH config file (passed as -F).

§control_master: Option<ControlMaster>

Enable SSH ControlMaster multiplexing.

§control_path: Option<String>

Path for ControlMaster socket (passed as -oControlPath=…).

§control_persist: Option<String>

ControlPersist timeout (e.g. “10m”, “yes”).

§proxy_jump: Option<String>

SSH ProxyJump host (passed as -J).

§port: Option<u16>

SSH port (passed as -p).

Implementations§

Source§

impl SshOptions

Source

pub fn build_ssh_cmd(&self, node: &str, command: &str) -> String

Build the SSH command prefix for a given node.

Returns the full SSH command string that will execute command on node.

Source

pub fn build_scp_cmd( &self, node: &str, source: &str, dest: &str, reverse: bool, preserve: bool, directory: bool, ) -> String

Build an SCP command for copying files to/from a node.

If reverse is true, copies from remote to local.

Trait Implementations§

Source§

impl Clone for SshOptions

Source§

fn clone(&self) -> Self

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 SshOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SshOptions

Source§

fn default() -> Self

Returns the “default value” for a type. 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.

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.