Struct Options

pub struct Options {
    pub command: Option<OsString>,
    pub disallow_shell: bool,
    pub kind: Option<ProgramKind>,
}

Available on crate feature blocking-client only.

The options for use when connecting via the ssh protocol.

Fields

command: Option<OsString>

The program or script to use. If unset, it defaults to ssh or ssh.exe, or the program implied by kind if that one is set.

disallow_shell: bool

If true, a shell must not be used to execute command. This defaults to false, and a shell can then be used if command seems to require it, but won’t be used unnecessarily.

kind: Option<ProgramKind>

The ssh variant further identifying program. This determines which arguments will be used when invoking the program. If unset, the program basename determines the variant, or an invocation of the command itself.

Implementations

impl Options

pub fn ssh_command(&self) -> &OsStr

Return the configured ssh command, defaulting to ssh if neither the command nor the kind fields are set.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.