Module prelude

Source
Expand description

A prelude of traits for working with ngrok types.

Structs§

Action
An action that should be taken if the rule matches
HttpTunnelBuilder
A builder for a tunnel backing an HTTP endpoint.
LabeledTunnelBuilder
A builder for a labeled tunnel.
OauthOptions
Oauth Options configuration
OidcOptions
Oidc Options configuration
Policy
A policy that defines rules that should be applied to incoming or outgoing connections to the edge.
Rule
A policy rule that should be applied
TcpTunnelBuilder
A builder for a tunnel backing a TCP endpoint.
TlsTunnelBuilder
A builder for a tunnel backing a TCP endpoint.

Enums§

EdgeType
The edge type for an incomming connection.
InvalidPolicy
Errors in creating or serializing Policies
ProxyProto
The version of PROXY protocol to use with this tunnel.
Scheme
The URL scheme for this HTTP endpoint.

Traits§

Conn
An incoming connection over an ngrok tunnel. Effectively a trait alias for async read+write, plus connection info.
ConnInfo
Information common to all ngrok connections.
EdgeConnInfo
Information about connections via ngrok edges.
EdgeInfo
An ngrok tunnel backing an edge. Since labels may be dynamically defined via the dashboard or API, the url and protocol for the tunnel is not knowable ahead of time.
EndpointConnInfo
Information about connections via ngrok endpoints.
EndpointInfo
An ngrok tunnel backing a simple endpoint. Most agent-configured tunnels fall into this category, with the exception of labeled tunnels.
Error
An error that may have an ngrok error code. All ngrok error codes are documented at https://ngrok.com/docs/errors
ForwarderBuilder
Trait representing things that can be built into an ngrok tunnel and then forwarded to a provided URL.
Tunnel
An ngrok tunnel.
TunnelBuilder
Trait representing things that can be built into an ngrok tunnel.
TunnelCloser
An ngrok tunnel closer.
TunnelExtDeprecated
Extension methods auto-implemented for all tunnel types
TunnelInfo
Information associated with an ngrok tunnel.