Struct trillium_forwarding::Forwarding [−][src]
pub struct Forwarding(_);
Expand description
Trillium handler for forwarded
/x-forwarded-*
headers
See crate-level docs for an explanation
Implementations
builds a Forwarding handler that trusts a list of strings that represent either specific IPs or a CIDR range.
let forwarding = Forwarding::trust_ips(["10.1.10.1"]);
let forwarding = Forwarding::trust_ips(["10.1.10.1", "192.168.0.0/16"]);
builds a Forwarding handler that trusts a peer ip based on the provided predicate function.
let forwarding = Forwarding::trust_fn(IpAddr::is_loopback);
let forwarding = Forwarding::trust_fn(|ip| match ip {
IpAddr::V6(_) => false,
IpAddr::V4(ipv4) => ipv4.is_link_local()
});
builds a Forwarding handler that expects that all http connections
will always come from a trusted and spec-compliant reverse
proxy. This should only be used in situations in which the
application is either running inside of a vpc and the reverse
proxy ip cannot be known. Using an overbroad trust rule such as
trust_always
introduces security risk to an application, as it
allows any request to forge Forwarded headers.
Trait Implementations
Returns the “default value” for a type. Read more
Executes this handler, performing any modifications to the Conn that are desired. Read more
Performs one-time async set up on a mutable borrow of the Handler before the server starts accepting requests. This allows a Handler to be defined in synchronous code but perform async setup such as establishing a database connection or fetching some state from an external source. This is optional, and chances are high that you do not need this. Read more
Performs any final modifications to this conn after all handlers have been run. Although this is a slight deviation from the simple conn->conn->conn chain represented by most Handlers, it provides an easy way for libraries to effectively inject a second handler into a response chain. This is useful for loggers that need to record information both before and after other handlers have run, as well as database transaction handlers and similar library code. Read more
predicate function answering the question of whether this Handler
would like to take ownership of the negotiated Upgrade. If this
returns true, you must implement Handler::upgrade
. The first
handler that responds true to this will receive ownership of the
trillium::Upgrade
in a subsequent call to Handler::upgrade
Read more
This will only be called if the handler reponds true to
Handler::has_upgrade
and will only be called once for this
upgrade. There is no return value, and this function takes
exclusive ownership of the underlying transport once this is
called. You can downcast the transport to whatever the source
transport type is and perform any non-http protocol communication
that has been negotiated. You probably don’t want this unless
you’re implementing something like websockets. Please note that
for many transports such as TcpStreams, dropping the transport
(and therefore the Upgrade) will hang up / disconnect. Read more