Skip to main content

Frontend

Struct Frontend 

Source
pub struct Frontend {
Show 14 fields pub cluster_id: Option<ClusterId>, pub redirect: RedirectPolicy, pub redirect_scheme: RedirectScheme, pub redirect_template: Option<String>, pub capture_cap_host: usize, pub capture_cap_path: usize, pub rewrite_host: Option<RewriteParts>, pub rewrite_path: Option<RewriteParts>, pub rewrite_port: Option<u16>, pub headers_request: Rc<[HeaderEdit]>, pub headers_response: Rc<[HeaderEdit]>, pub required_auth: bool, pub tags: Option<Rc<CachedTags>>, pub inherits_listener_hsts: bool,
}
Expand description

What to do with the traffic for a routed frontend.

Built once at frontend registration time. The expensive work (parsing rewrite templates, resolving headers into HeaderEdits) happens here so Router::lookup can run cheaply on the hot path.

A clusterless frontend with redirect == FORWARD is coerced to UNAUTHORIZED in Frontend::new to avoid a forward loop with no backend; the explicit UNAUTHORIZED policy then renders a 401.

Tags are wrapped in Rc<CachedTags> so the same frontend can be referenced from multiple routing slots (pre/tree/post) without copying.

Fields§

§cluster_id: Option<ClusterId>§redirect: RedirectPolicy§redirect_scheme: RedirectScheme§redirect_template: Option<String>§capture_cap_host: usize

Number of host captures the router will collect for this frontend. Sized from the matching DomainRule; the router skips capture extraction entirely when this is 0 (no rewrite references $HOST[…]).

§capture_cap_path: usize

Number of path captures the router will collect for this frontend. Sized from the matching PathRule; the router skips capture extraction entirely when this is 0 (no rewrite references $PATH[…]).

§rewrite_host: Option<RewriteParts>§rewrite_path: Option<RewriteParts>§rewrite_port: Option<u16>§headers_request: Rc<[HeaderEdit]>§headers_response: Rc<[HeaderEdit]>§required_auth: bool§tags: Option<Rc<CachedTags>>§inherits_listener_hsts: bool

true when the materialised HSTS edit (if any) in Self::headers_response came from the listener-default HttpsListenerConfig.hsts rather than the per-frontend RequestHttpFrontend.hsts block. Consulted by Router::refresh_inheriting_hsts so a UpdateHttpsListenerConfig.hsts patch reflows the new default onto inheriting frontends without overwriting explicit per-frontend HSTS overrides.

Implementations§

Source§

impl Frontend

Source

pub fn new( domain_rule: &DomainRule, path_rule: &PathRule, front: &HttpFrontend, redirect: RedirectPolicy, redirect_scheme: RedirectScheme, redirect_template: Option<String>, rewrite_host: Option<String>, rewrite_path: Option<String>, rewrite_port: Option<u16>, headers: &[Header], required_auth: bool, hsts_origin: HstsOrigin, ) -> Result<Self, RouterError>

Build a Frontend from a domain/path rule pair and an HttpFrontend configuration.

The richer proto-level fields (redirect, redirect_scheme, redirect_template, rewrite_*, headers, required_auth) are not yet carried on HttpFrontend; until they are, this constructor takes them as explicit arguments so the data flow is testable today and the call sites in add_http_front only need a one-line update once the fields are plumbed through.

Coercions:

  • redirect == UNAUTHORIZED zeroes out rewrite/headers/auth — the request will be rejected with a 401 regardless.
  • redirect == FORWARD on a clusterless frontend (cluster_id == None) is coerced to UNAUTHORIZED (logged as a warning) to avoid a forward loop with no backend.

Returns RouterError::InvalidHostRewrite / RouterError::InvalidPathRewrite when a rewrite template fails to parse against the rule’s capture caps.

Trait Implementations§

Source§

impl Clone for Frontend

Source§

fn clone(&self) -> Frontend

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 Frontend

Source§

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

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

impl Eq for Frontend

Source§

impl Hash for Frontend

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Frontend

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Frontend

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Frontend

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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