Struct mz_ssh_util::tunnel::SshTunnelConfig

pub struct SshTunnelConfig {
    pub host: String,
    pub port: u16,
    pub user: String,
    pub key_pair: SshKeyPair,
}

Specifies an SSH tunnel.

Fields

host: String

The hostname of the SSH bastion server.

port: u16

The port to connect to.

user: String

The name of the user to connect as.

key_pair: SshKeyPair

The SSH key pair to authenticate with.

Implementations

impl SshTunnelConfig

pub async fn connect(
    &self,
    host: &str,
    port: u16
) -> Result<(Session, u16), Error>

Establishes a connection to the specified host and port via the configured SSH tunnel.

Returns the Session value you must keep alive to keep the tunnel open and the local port the tunnel is listening on.

Trait Implementations

impl Clone for SshTunnelConfig

fn clone(&self) -> SshTunnelConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SshTunnelConfig

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

Formats the value using the given formatter.

impl PartialEq<SshTunnelConfig> for SshTunnelConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SshTunnelConfig