Skip to main content

Route

Struct Route 

Source
pub struct Route {
    pub matcher: RouteMatch,
    pub filters: Vec<String>,
    pub upstream: Option<String>,
    pub backends: Vec<Backend>,
    pub strip_prefix: Option<String>,
    pub rate_limit: Option<RouteRateLimit>,
    pub upgrade: Option<RouteUpgrade>,
    pub compression: Option<RouteCompression>,
}
Expand description

One routing rule (ADR 000013 / 000034): match a request by the [route.match] dimensions, run an inline chain of filters, and forward to a single upstream (shorthand) or a weighted set of backends (traffic split / canary). strip_prefix is a host-native path rewrite applied to the forwarded request only (the chain still sees the original path) — the common reverse-proxy prefix-strip, without a plecto:filter contract change. filters / strip_prefix / rate_limit are per-route: they apply identically across every backend (ADR 000034 keeps a backend a pure {upstream, weight} pair; a route needing different policy per target uses a separate route).

Fields§

§matcher: RouteMatch

The match dimensions ([route.match]): host / path_prefix / method / headers / query (ADR 000034). At least path_prefix is required; all other dimensions are optional and ANDed.

§filters: Vec<String>

This route’s chain: filter ids run in order (may be empty for a pure pass-through route).

§upstream: Option<String>

Single-upstream shorthand: the [[upstream]] name to forward a passing request to. Mutually exclusive with backends (exactly one is required; validated at build). A single upstream is normalised to a one-element weighted set (weight 1) at compile time.

§backends: Vec<Backend>

Weighted traffic split (ADR 000034): forward to these {upstream, weight} backends in proportion to their weights (canary). Mutually exclusive with upstream. Empty unless used.

§strip_prefix: Option<String>

If set and the forwarded path starts with it, strip it before forwarding to the upstream (host-native rewrite; the chain saw the original path). E.g. /api + /api/x/x.

§rate_limit: Option<RouteRateLimit>

Native fast-path rate limit (ADR 000033): a coarse token-bucket baseline consulted BEFORE this route’s filter chain. Absent = unlimited (the default). Distinct from the per-filter host-ratelimit capability (ADR 000026): this is the operator’s native floor on a route (or per client-IP), needs no WASM filter, and never crosses the WASM boundary.

§upgrade: Option<RouteUpgrade>

HTTP/1.1 Upgrade opt-in (ADR 000048): the Upgrade tokens this route tunnels. Absent = deny-by-default (the Upgrade/Connection pair keeps being stripped as hop-by-hop).

§compression: Option<RouteCompression>

Native response compression opt-in (ADR 000074 / 000075): negotiate a content coding against the client’s Accept-Encoding and compress eligible responses AFTER the response chain (filters always see identity). Absent = never transform — deny-by-default, which is also the per-route BREACH opt-out. Do not enable on routes that reflect secrets into the response body (CSRF tokens, session nonces echoed from the request): compression + reflection enables BREACH-class chosen-plaintext attacks against TLS. Leave those routes uncompressed.

Trait Implementations§

Source§

impl Clone for Route

Source§

fn clone(&self) -> Route

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Route

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Route

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for Route

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for Route

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Route

§

impl RefUnwindSafe for Route

§

impl Send for Route

§

impl Sync for Route

§

impl Unpin for Route

§

impl UnsafeUnpin for Route

§

impl UnwindSafe for Route

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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