Struct ngrok :: Session Copy item path

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.

https://ngrok.com/docs/http/

pub fn tcp_endpoint(&self) -> TcpTunnelBuilder

Start building a tunnel for a TCP endpoint.

https://ngrok.com/docs/tcp/

pub fn tls_endpoint(&self) -> TlsTunnelBuilder

Start building a tunnel for a TLS endpoint.

https://ngrok.com/docs/tls/

pub fn labeled_tunnel(&self) -> LabeledTunnelBuilder

Start building a labeled tunnel.

https://ngrok.com/docs/network-edge/edges/#tunnel-group

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. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

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.

Auto Trait Implementations§

impl !UnwindSafe for Session

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more