Struct ngrok::session::Session

pub struct Session { /* private fields */ }

An ngrok session.

Encapsulates an established session with the ngrok service. Sessions recover from network failures by automatically reconnecting.

Implementations

impl Session

pub fn builder() -> SessionBuilder

Create a new SessionBuilder to configure a new ngrok session.

pub fn http_endpoint(&self) -> HttpTunnelBuilder

Start building a tunnel for an HTTP endpoint.

pub fn tcp_endpoint(&self) -> TcpTunnelBuilder

Start building a tunnel for a TCP endpoint.

pub fn tls_endpoint(&self) -> TlsTunnelBuilder

Start building a tunnel for a TLS endpoint.

pub fn labeled_tunnel(&self) -> LabeledTunnelBuilder

Start building a labeled tunnel.

pub fn id(&self) -> String

Get the unique ID of this session.

pub async fn close_tunnel(&self, id: impl AsRef<str>) -> Result<(), RpcError>

Close a tunnel with the given ID.

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

Close the ngrok session.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Session> for HttpTunnelBuilder

fn from(session: Session) -> Self

Converts to this type from the input type.

impl From<Session> for LabeledTunnelBuilder

fn from(session: Session) -> Self

Converts to this type from the input type.

impl From<Session> for TcpTunnelBuilder

fn from(session: Session) -> Self

Converts to this type from the input type.

impl From<Session> for TlsTunnelBuilder

fn from(session: Session) -> Self

Converts to this type from the input type.