Skip to main content

H3ReverseProxy

Struct H3ReverseProxy 

Source
pub struct H3ReverseProxy { /* private fields */ }
Expand description

Reverse proxy that forwards requests to https:// backends over HTTP/3 (QUIC). Since 18.13.0; requires the http3 feature (default).

A backend QUIC can’t reach (UDP blocked, no handshake within the connect timeout, a TLS failure) is sent the request over HTTPS on TCP instead, and stays on TCP for five minutes; rws_upstream_h3_fallbacks_total counts it under the proxy’s name.

use rust_web_server::app::App;
use rust_web_server::core::New;
use rust_web_server::proxy::H3ReverseProxy;

let proxy = H3ReverseProxy::new(["https://edge1.internal:443", "https://edge2.internal:443"])
    .path_prefix("/api")
    .tls_ca_file("/etc/rws/internal-ca.pem")
    .unwrap();
let app = App::new().wrap(proxy);

Implementations§

Source§

impl H3ReverseProxy

Source

pub fn new<I, S>(backends: I) -> Self
where I: IntoIterator<Item = S>, S: AsRef<str>,

A proxy distributing requests across backends (https://host:port, port 443 by default) in round-robin order. Certificates are checked against the WebPKI roots unless tls_ca_file says otherwise. A backend that isn’t https:// is reached over HTTP/1.1 on TCP.

Source

pub fn name(self, name: impl Into<String>) -> Self

The upstream label of this proxy’s fallback metric.

Source

pub fn path_prefix(self, prefix: impl Into<String>) -> Self

Only proxy requests whose URI starts with prefix; pass others through.

Source

pub fn connect_timeout_ms(self, ms: u64) -> Self

QUIC handshake (and TCP connect) timeout (default: 5 s).

Source

pub fn read_timeout_ms(self, ms: u64) -> Self

Longest wait for the backend — the response head and each body chunk (default: 30 s).

Source

pub fn tls_ca_file(self, path: &str) -> Result<Self, String>

Trust the CA certificates in the PEM file path instead of the WebPKI roots.

Source

pub fn tls_client_cert(self, cert: &str, key: &str) -> Result<Self, String>

Present a client certificate to backends that require one.

Trait Implementations§

Source§

impl Middleware for H3ReverseProxy

Available on crate feature http3 only.
Source§

fn answers_streamed_body( &self, request: &Request, _connection: &ConnectionInfo, ) -> bool

Requests this proxy forwards are sent as their body arrives.

Source§

fn handle( &self, request: &Request, connection: &ConnectionInfo, next: &dyn Application, ) -> Result<Response, String>

Source§

fn accepts_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when this layer never reads request.body, so the inner application may receive it as a stream (Application::streams_body). A layer that inspects the body (CSRF tokens in a form, request signatures, rewriting) must keep the default false: it would see an empty body.
Source§

fn runs_inline(&self, _request: &Request, _connection: &ConnectionInfo) -> bool

true when this layer’s own work for request never blocks (in-memory state, atomics, short mutexes) — see Application::runs_inline. A WithMiddleware stack runs inline only if every layer and the inner application agree. Default false.
Source§

fn is_passthrough( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when handle would do nothing for request but call next (e.g. a rate limit that isn’t configured). A WithMiddleware stack offers the inner application’s execute_async only if every layer passes the request through. Default false.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more