Struct SshEndpoint 

pub struct SshEndpoint { /* private fields */ }

Strict-host-key SSH connection material.

Implementations

impl SshEndpoint

pub fn new(host: impl Into<String>) -> Result<Self, TopologyError>

Creates an SSH endpoint using port 22.

pub fn with_port(self, port: u16) -> Result<Self, TopologyError>

Sets the SSH port.

pub fn with_user(self, user: impl Into<String>) -> Result<Self, TopologyError>

Sets the optional SSH user.

pub fn with_identity_file( self, path: impl Into<PathBuf>, ) -> Result<Self, TopologyError>

Sets an absolute identity-file path.

pub fn with_config_file( self, path: impl Into<PathBuf>, ) -> Result<Self, TopologyError>

Sets an absolute SSH config path.

pub fn with_known_hosts_file( self, path: impl Into<PathBuf>, ) -> Result<Self, TopologyError>

Sets an absolute known-hosts path used with strict verification.

pub fn host(&self) -> &str

Returns the SSH hostname or config alias.

pub const fn port(&self) -> u16

Returns the SSH port.

pub fn user(&self) -> Option<&str>

Returns the optional SSH user.

pub fn identity_file(&self) -> Option<&Path>

Returns the optional identity-file path.

pub fn config_file(&self) -> Option<&Path>

Returns the optional config-file path.

pub fn known_hosts_file(&self) -> Option<&Path>

Returns the optional strict known-hosts path.

Trait Implementations

impl Clone for SshEndpoint

fn clone(&self) -> SshEndpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SshEndpoint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SshEndpoint

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SshEndpoint

fn eq(&self, other: &SshEndpoint) -> 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 SshEndpoint

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SshEndpoint

impl StructuralPartialEq for SshEndpoint