Struct ngrok::config::TlsTunnelBuilder

pub struct TlsTunnelBuilder { /* private fields */ }

A builder for a tunnel backing a TCP endpoint.

Implementations

impl TlsTunnelBuilder

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

Add the provided CIDR to the allowlist.

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

Add the provided CIDR to the denylist.

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

Sets the PROXY protocol version for connections over this tunnel.

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

Sets the opaque metadata string for this tunnel.

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

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

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

Sets the domain to request for this edge.

pub fn mutual_tlsca(self, mutual_tlsca: Bytes) -> 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.

pub fn termination(self, cert_pem: Bytes, key_pem: Bytes) -> Self

Sets the key and certificate in PEM format for TLS termination at the ngrok edge.

Trait Implementations

impl Clone for TlsTunnelBuilder

fn clone(&self) -> TlsTunnelBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Session> for TlsTunnelBuilder

fn from(session: Session) -> Self

Converts to this type from the input type.

impl TunnelBuilder for TlsTunnelBuilder

type Tunnel = TlsTunnel

The ngrok tunnel type that this builder produces.

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

Begin listening for new connections on this tunnel.