Struct ngrok :: prelude :: TcpTunnelBuilder Copy item path

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

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.

Trait Implementations§

impl Clone for TcpTunnelBuilder

fn clone(&self) -> TcpTunnelBuilder

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

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.

Auto Trait Implementations§

impl !UnwindSafe for TcpTunnelBuilder

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more