Expand description
A prelude of traits for working with ngrok types.
Structs§
- Action
- An action that should be taken if the rule matches
- Http
Tunnel Builder - A builder for a tunnel backing an HTTP endpoint.
- Labeled
Tunnel Builder - A builder for a labeled tunnel.
- Oauth
Options - Oauth Options configuration
- Oidc
Options - 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
- TcpTunnel
Builder - A builder for a tunnel backing a TCP endpoint.
- TlsTunnel
Builder - A builder for a tunnel backing a TCP endpoint.
Enums§
- Edge
Type - The edge type for an incomming connection.
- Invalid
Policy - Errors in creating or serializing Policies
- Proxy
Proto - 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.
- Conn
Info - Information common to all ngrok connections.
- Edge
Conn Info - Information about connections via ngrok edges.
- Edge
Info - 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.
- Endpoint
Conn Info - Information about connections via ngrok endpoints.
- Endpoint
Info - 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
- Forwarder
Builder - Trait representing things that can be built into an ngrok tunnel and then forwarded to a provided URL.
- Tunnel
- An ngrok tunnel.
- Tunnel
Builder - Trait representing things that can be built into an ngrok tunnel.
- Tunnel
Closer - An ngrok tunnel closer.
- Tunnel
Ext Deprecated - Extension methods auto-implemented for all tunnel types
- Tunnel
Info - Information associated with an ngrok tunnel.