Struct TcpTunnelBuilder 

pub struct TcpTunnelBuilder { /* private fields */ }

A builder for a tunnel backing a TCP endpoint.

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

Implementations

impl TcpTunnelBuilder

The options for a TCP edge.

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

Add the provided CIDR to the allowlist.

https://ngrok.com/docs/tcp/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/tcp/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.tcp_endpoint().binding("internal").listen().await?;

// Using typed enum
use ngrok::config::Binding;
let tunnel = session.tcp_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 verify_upstream_tls(&mut self, verify_upstream_tls: bool) -> &mut Self

Disables backend TLS certificate verification for forwards from this tunnel.

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

Sets the TCP address to request for this edge.

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

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 TcpTunnelBuilder

fn clone(&self) -> TcpTunnelBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ForwarderBuilder for TcpTunnelBuilder

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

fn from(session: Session) -> Self

Converts to this type from the input type.

impl TunnelBuilder for TcpTunnelBuilder

type Tunnel = TcpTunnel

The ngrok tunnel type that this builder produces.

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

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

Begin listening for new connections on this tunnel.