Struct ngrok :: prelude :: LabeledTunnelBuilder Copy item path

impl LabeledTunnelBuilder

pub fn metadata(&mut self, metadata: impl Into<String>) -> &mut Self

Sets the opaque metadata string for this tunnel. Viewable via the API.

https://ngrok.com/docs/api/resources/tunnels/#tunnel-fields

pub fn label( &mut self, label: impl Into<String>, value: impl Into<String> ) -> &mut Self

Add a label, value pair for this tunnel.

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

pub fn forwards_to(&mut self, forwards_to: impl Into<String>) -> &mut Self

Sets the ForwardsTo string for this tunnel. This can be viewed via the API or dashboard.

This overrides the default process info if using TunnelBuilder::listen, and is in turn overridden by the url provided to ForwarderBuilder::listen_and_forward.

https://ngrok.com/docs/api/resources/tunnels/#tunnel-fields

pub fn app_protocol(&mut self, app_protocol: impl Into<String>) -> &mut Self

Sets the L7 protocol string for this tunnel.

pub fn verify_upstream_tls(&mut self, verify_upstream_tls: bool) -> &mut Self

Disables backend TLS certificate verification for forwards from this tunnel.

Trait Implementations§

impl Clone for LabeledTunnelBuilder

fn clone(&self) -> LabeledTunnelBuilder

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 ForwarderBuilder for LabeledTunnelBuilder

fn listen_and_forward<'life0, 'async_trait>( &'life0 self, to_url: Url ) -> Pin<Box<dyn Future<Output = Result<Forwarder<LabeledTunnel>, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Start listening for new connections on this tunnel and forward all connections to the provided URL. Read more

impl From<Session> for LabeledTunnelBuilder

fn from(session: Session) -> Self

Converts to this type from the input type.

impl TunnelBuilder for LabeledTunnelBuilder

type Tunnel = LabeledTunnel

The ngrok tunnel type that this builder produces.

fn listen<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<LabeledTunnel, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Begin listening for new connections on this tunnel.

Auto Trait Implementations§

impl !UnwindSafe for LabeledTunnelBuilder

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