Struct trillium_proxy::Proxy [−][src]
pub struct Proxy<C: Connector> { /* fields omitted */ }
Expand description
the proxy handler
Implementations
construct a new proxy handler that sends all requests to the url provided. if the url contains a path, the inbound request path will be joined onto the end.
use trillium_smol::{TcpConnector, ClientConfig}; use trillium_proxy::Proxy; let proxy = Proxy::<TcpConnector>::new("http://docs.trillium.rs/trillium_proxy");
chainable constructor to specify the client Connector configuration
use trillium_smol::{TcpConnector, ClientConfig}; use trillium_proxy::Proxy; let proxy = Proxy::<TcpConnector>::new("http://trillium.rs") .with_config(ClientConfig { //<- nodelay: Some(true), ..Default::default() });
chainable constructor to specfiy a Client
to use. This is
useful if the application already is using trillium_client for
other requests, as it will reuse the same connection pool and
connector config.
note that this clears out any changes made with
Proxy::with_config
. configure the client directly if you are
providing one
use trillium_smol::{TcpConnector, ClientConfig}; use trillium_proxy::{Proxy, Client}; let client = Client::new().with_default_pool(); let proxy = Proxy::<TcpConnector>::new("http://trillium.rs") .with_client(client); //<-
// sharing a client with other trillium handlers use trillium::State; let client = Client::new().with_default_pool(); let handler = ( State::new(client.clone()), Proxy::<TcpConnector>::new("http://trillium.rs").with_client(client) );
chainable constructor to set the 404 Not Found handling
behavior. By default, this proxy will pass through the trillium
Conn unmodified if the proxy response is a 404 not found, allowing
it to be chained in a tuple handler. To modify this behavior, call
proxy_not_found, and the full 404 response will be forwarded. The
Conn will be halted unless Proxy::without_halting
was
configured
let proxy = Proxy::<TcpConnector>::new("http://trillium.rs") .proxy_not_found();
The default behavior for this handler is to halt the conn on any
response other than a 404. If Proxy::proxy_not_found
has been
configured, the default behavior for all response statuses is to
halt the trillium conn. To change this behavior, call
without_halting when constructing the proxy, and it will not halt
the conn. This is useful when passing the proxy reply through
trillium_html_rewriter
.
let proxy = Proxy::<TcpConnector>::new("http://trillium.rs") .without_halting();
Trait Implementations
Executes this handler, performing any modifications to the Conn that are desired. 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
Performes 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
Auto Trait Implementations
impl<C> RefUnwindSafe for Proxy<C> where
<C as Connector>::Config: RefUnwindSafe,
impl<C> UnwindSafe for Proxy<C> where
<C as Connector>::Config: UnwindSafe,