Struct HttpTunnelBuilder

pub struct HttpTunnelBuilder { /* private fields */ }

A builder for a tunnel backing an HTTP endpoint.

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

Implementations

impl HttpTunnelBuilder

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

Add the provided CIDR to the allowlist.

https://ngrok.com/docs/http/ip-restrictions/

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

Add the provided CIDR to the denylist.

https://ngrok.com/docs/http/ip-restrictions/

pub fn proxy_proto(&mut self, proxy_proto: ProxyProto) -> &mut Self

Sets the PROXY protocol version for connections over this tunnel.

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

Sets the opaque metadata string for this tunnel.

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

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

Sets the ingress configuration for this endpoint.

Valid binding values are:

• "public" - Publicly accessible endpoint
• "internal" - Internal-only endpoint
• "kubernetes" - Kubernetes cluster binding

If not specified, the ngrok service will use its default binding configuration.

Panics

Panics if called more than once or if an invalid binding value is provided.

Examples

let session = Session::builder().authtoken_from_env().connect().await?;

// Using string
let tunnel = session.http_endpoint().binding("internal").listen().await?;

// Using typed enum
use ngrok::config::Binding;
let tunnel = session.http_endpoint().binding(Binding::Public).listen().await?;

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

pub fn scheme(&mut self, scheme: Scheme) -> &mut Self

Sets the scheme for this edge.

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

Sets the domain to request for this edge.

https://ngrok.com/docs/network-edge/domains-and-tcp-addresses/#domains

pub fn mutual_tlsca(&mut self, mutual_tlsca: Bytes) -> &mut Self

Adds a certificate in PEM format to use for mutual TLS authentication.

These will be used to authenticate client certificates for requests at the ngrok edge.

https://ngrok.com/docs/http/mutual-tls/

pub fn compression(&mut self) -> &mut Self

Enables gzip compression.

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

pub fn websocket_tcp_conversion(&mut self) -> &mut Self

Enables the websocket-to-tcp converter.

https://ngrok.com/docs/http/websocket-tcp-converter/

pub fn circuit_breaker(&mut self, circuit_breaker: f64) -> &mut Self

Sets the 5XX response ratio at which the ngrok edge will stop sending requests to this tunnel.

https://ngrok.com/docs/http/circuit-breaker/

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

Automatically rewrite the host header to the one in the provided URL when calling ForwarderBuilder::listen_and_forward. Does nothing if using TunnelBuilder::listen. Defaults to false.

If you need to set the host header to a specific value, use cfg.request_header("host", "some.host.com") instead.

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

Adds a header to all requests to this edge.

https://ngrok.com/docs/http/request-headers/

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

Adds a header to all responses coming from this edge.

https://ngrok.com/docs/http/response-headers/

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

Removes a header from requests to this edge.

https://ngrok.com/docs/http/request-headers/

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

Removes a header from responses from this edge.

https://ngrok.com/docs/http/response-headers/

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

Adds the provided credentials to the list of basic authentication credentials.

https://ngrok.com/docs/http/basic-auth/

pub fn oauth(&mut self, oauth: impl Borrow<OauthOptions>) -> &mut Self

Set the OAuth configuraton for this edge.

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

pub fn oidc(&mut self, oidc: impl Borrow<OidcOptions>) -> &mut Self

Set the OIDC configuration for this edge.

https://ngrok.com/docs/http/openid-connect/

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

Configures webhook verification for this edge.

https://ngrok.com/docs/http/webhook-verification/

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

Add the provided regex to the allowlist.

https://ngrok.com/docs/http/user-agent-filter/

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

Add the provided regex to the denylist.

https://ngrok.com/docs/http/user-agent-filter/

pub fn policy<S>(&mut self, s: S) -> Result<&mut Self, S::Error>

where S: TryInto<Policy>,

DEPRECATED: use traffic_policy instead.

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

Set policy for this edge.

pub fn pooling_enabled(&mut self, pooling_enabled: impl Into<bool>) -> &mut Self

Allows the endpoint to pool with other endpoints with the same host/port/binding

Trait Implementations

impl Clone for HttpTunnelBuilder

fn clone(&self) -> HttpTunnelBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ForwarderBuilder for HttpTunnelBuilder

fn listen_and_forward<'life0, 'async_trait>( &'life0 self, to_url: Url, ) -> Pin<Box<dyn Future<Output = Result<Forwarder<HttpTunnel>, 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.

impl From<Session> for HttpTunnelBuilder

fn from(session: Session) -> Self

Converts to this type from the input type.

impl TunnelBuilder for HttpTunnelBuilder

type Tunnel = HttpTunnel

The ngrok tunnel type that this builder produces.

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

where Self: 'async_trait, 'life0: 'async_trait,

Begin listening for new connections on this tunnel.