Struct ClientConfig 

#[non_exhaustive]
pub struct ClientConfig { /* private fields */ }

Client connection configuration.

Implementations

impl ClientConfig

pub fn new(endpoint: impl Into<Endpoint>) -> Self

Creates a config for the given endpoint.

pub fn endpoint(&self) -> &Endpoint

Returns the configured endpoint.

pub fn set_endpoint(&mut self, endpoint: impl Into<Endpoint>)

Sets the endpoint.

pub fn username(&self) -> Option<&Username>

Returns the optional username.

pub fn set_username(&mut self, username: impl Into<Username>)

Sets the username.

pub fn credentials(&self) -> &[Credential]

Returns configured credentials in preference order.

pub fn add_credential(&mut self, credential: Credential)

Adds a credential.

pub fn use_agent(&mut self)

Adds an SSH agent credential.

pub fn timeouts(&self) -> &Timeouts

Returns timeout settings.

pub fn set_timeouts(&mut self, timeouts: Timeouts)

Sets timeout settings.

pub fn keepalive(&self) -> &Keepalive

Returns keepalive settings.

pub fn set_keepalive(&mut self, keepalive: Keepalive)

Sets keepalive settings.

pub fn strict_host_key_checking(&self) -> bool

Returns whether strict host key checking is enabled.

pub fn set_strict_host_key_checking(&mut self, enabled: bool)

👎Deprecated:

use set_host_key_policy instead

Sets strict host key checking.

pub fn host_key_policy(&self) -> &HostKeyPolicy

Returns the configured host-key policy.

pub fn set_host_key_policy(&mut self, policy: HostKeyPolicy)

Sets the host-key policy.

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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 Eq for ClientConfig

impl StructuralPartialEq for ClientConfig