Struct mz_ssh_util::tunnel::SshTunnelConfig

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

Specifies an SSH tunnel.

Fields

host: BTreeSet<String>

The hostname/IP of the SSH bastion server. If multiple hosts are specified, they are tried in order.

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, remote_host: &str, remote_port: u16, timeout_config: SshTimeoutConfig, ) -> Result<SshTunnelHandle, Error>

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

Returns a handle to the SSH tunnel. The SSH tunnel is automatically shut down when the handle is dropped.

pub async fn validate( &self, timeout_config: SshTimeoutConfig, ) -> Result<(), Error>

Validates the SSH configuration by establishing a connection to the intermediate SSH bastion host. It does not set up a port forwarding tunnel.

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 Display for SshTunnelConfig

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

Formats the value using the given formatter.

impl Ord for SshTunnelConfig

fn cmp(&self, other: &SshTunnelConfig) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SshTunnelConfig

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

fn partial_cmp(&self, other: &SshTunnelConfig) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for SshTunnelConfig

impl StructuralPartialEq for SshTunnelConfig