Struct mz_ssh_util::tunnel_manager::ManagedSshTunnelHandle

pub struct ManagedSshTunnelHandle {
    handle: Arc<SshTunnelHandle>,
    manager: SshTunnelManager,
    key: SshTunnelKey,
}

A clonable handle to an SSH tunnel managed by an SshTunnelManager.

The tunnel will be automatically closed when all handles are dropped.

Fields

handle: Arc<SshTunnelHandle>

manager: SshTunnelManager

key: SshTunnelKey

Methods from Deref<Target = SshTunnelHandle>

pub fn local_addr(&self) -> SocketAddr

Returns the local address at which the SSH tunnel is listening.

pub fn check_status(&self) -> SshTunnelStatus

Returns the current status of the SSH tunnel.

Note this status may be stale, as the health of the underlying SSH tunnel is only checked periodically.

Trait Implementations

impl Clone for ManagedSshTunnelHandle

fn clone(&self) -> ManagedSshTunnelHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ManagedSshTunnelHandle

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

Formats the value using the given formatter.

impl Deref for ManagedSshTunnelHandle

type Target = SshTunnelHandle

The resulting type after dereferencing.

fn deref(&self) -> &SshTunnelHandle

Dereferences the value.

impl Drop for ManagedSshTunnelHandle

fn drop(&mut self)

Executes the destructor for this type.