Struct ActiveTunnel

pub struct ActiveTunnel {
    pub name: String,
    pub id: String,
    /* private fields */
}

Representation of a tunnel returned from the start methods.

Fields

name: String

Name of the tunnel

id: String

Underlying dev tunnels ID

Implementations

impl ActiveTunnel

pub async fn close(&mut self) -> Result<(), AnyError>

Closes and unregisters the tunnel.

pub async fn add_port_direct( &mut self, port_number: u16, ) -> Result<UnboundedReceiver<ForwardedPortConnection>, AnyError>

Forwards a port to local connections.

pub async fn add_port_tcp( &self, port_number: u16, privacy: PortPrivacy, ) -> Result<(), AnyError>

Forwards a port over TCP.

pub async fn remove_port(&self, port_number: u16) -> Result<(), AnyError>

Removes a forwarded port TCP.

pub fn get_port_format(&self) -> Result<String, AnyError>

Gets the template string for forming forwarded port web URIs..

pub fn get_port_uri(&self, port: u16) -> Result<String, AnyError>

Gets the public URI on which a forwarded port can be access in browser.

pub fn status(&self) -> StatusLock

Gets an object to read the current tunnel status.