Struct ClientConfig 

pub struct ClientConfig {
    pub ssh_config_path: String,
    pub program: String,
    pub arguments: Vec<String>,
    pub username_host_placeholder: String,
}

Representation of the client subcommand configurations.

Fields

ssh_config_path: String

Full path to the SSH config.

Example

'C:\Users\<username>\.ssh\config'

program: String

Name of the program used to establish the SSH connection.

Example

'ssh'

arguments: Vec<String>

List of arguments provided to the program.

Must include the username_host_placeholder.

Example

['-XY', '{{USERNAME_AT_HOST}}']

username_host_placeholder: String

Placeholder string used to inject <user>@<host> into the list of arguments.

Example

'{{USERNAME_AT_HOST}}'

Trait Implementations

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Default for ClientConfig

fn default() -> Self

Returns a sensible default ClientConfig.

Returns

ClientConfig with the following values:

• ssh_config_path - %USERPROFILE%\.ssh\config
• program - ssh
• arguments - -XY {{USERNAME_AT_HOST}}
• usernamt_host_placeholder - {{USERNAME_AT_HOST}}

Note: %USERPROFILE% actually is resolved by us, so the actual value is whatever the environment variable at runtime points to.

impl<'de> Deserialize<'de> for ClientConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ClientConfig> for ClientConfigOpt

fn from(val: ClientConfig) -> Self

Wraps all configuration values as options.

impl From<ClientConfigOpt> for ClientConfig

fn from(val: ClientConfigOpt) -> Self

Unwraps the existing configuration values or applies the default.

impl PartialEq for ClientConfig

fn eq(&self, other: &ClientConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ClientConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ClientConfig