Struct RequestHttpFrontend 

pub struct RequestHttpFrontend {

    pub cluster_id: Option<String>,
    pub address: SocketAddress,
    pub hostname: String,
    pub path: PathRule,
    pub method: Option<String>,
    pub position: i32,
    pub tags: BTreeMap<String, String>,
    pub redirect: Option<i32>,
    pub required_auth: Option<bool>,
    pub redirect_scheme: Option<i32>,
    pub redirect_template: Option<String>,
    pub rewrite_host: Option<String>,
    pub rewrite_path: Option<String>,
    pub rewrite_port: Option<u32>,
    pub headers: Vec<Header>,
    pub hsts: Option<HstsConfig>,
}

An HTTP or HTTPS frontend, as order to, or received from, Sōzu

Fields

cluster_id: Option<String>

address: SocketAddress

hostname: String

path: PathRule

method: Option<String>

position: i32

tags: BTreeMap<String, String>

custom tags to identify the frontend in the access logs

redirect: Option<i32>

Redirect policy for this frontend. Default FORWARD (no redirect).

required_auth: Option<bool>

When true, requests routed through this frontend must carry a valid Authorization: Basic <user:pass> header whose hash matches one of cluster.authorized_hashes. Default: false.

redirect_scheme: Option<i32>

Scheme to use when emitting a 301 Location header. Default USE_SAME (preserve the request scheme).

redirect_template: Option<String>

Optional template applied when emitting a permanent redirect. Supports %REDIRECT_LOCATION and the variables documented in doc/configure.md.

rewrite_host: Option<String>

Rewrite host template. Supports $HOST\[n\] / $PATH\[n\] placeholders populated from regex captures collected during routing. When set, both the backend authority/path and the wire request line are rewritten.

rewrite_path: Option<String>

Rewrite path template. Same grammar as rewrite_host.

rewrite_port: Option<u32>

Optional literal port override on the rewritten URL.

headers: Vec<Header>

Header mutations applied to requests and/or responses passing through this frontend. See Header for delete semantics.

hsts: Option<HstsConfig>

Per-frontend HSTS (RFC 6797) override. When Some, this entire policy replaces the listener-default HttpsListenerConfig.hsts for matched requests; when absent, the listener default applies. Honours RFC 6797 §6.1 (single Strict-Transport-Security header on the response) and §8.1 (HSTS host scope tied to the receiving host). On HTTP-only frontends the value is rejected at config-load (RFC 6797 §7.2). The §11.4 max-age=0 kill-switch is honoured verbatim so an operator can shadow a listener-wide HSTS for one hostname.

Implementations

impl RequestHttpFrontend

pub fn cluster_id(&self) -> &str

Returns the value of cluster_id, or the default value if cluster_id is unset.

pub fn method(&self) -> &str

Returns the value of method, or the default value if method is unset.

pub fn position(&self) -> RulePosition

Returns the enum value of position, or the default if the field is set to an invalid enum value.

pub fn set_position(&mut self, value: RulePosition)

Sets position to the provided enum value.

pub fn redirect(&self) -> RedirectPolicy

Returns the enum value of redirect, or the default if the field is unset or set to an invalid enum value.

pub fn set_redirect(&mut self, value: RedirectPolicy)

Sets redirect to the provided enum value.

pub fn required_auth(&self) -> bool

Returns the value of required_auth, or the default value if required_auth is unset.

pub fn redirect_scheme(&self) -> RedirectScheme

Returns the enum value of redirect_scheme, or the default if the field is unset or set to an invalid enum value.

pub fn set_redirect_scheme(&mut self, value: RedirectScheme)

Sets redirect_scheme to the provided enum value.

pub fn redirect_template(&self) -> &str

Returns the value of redirect_template, or the default value if redirect_template is unset.

pub fn rewrite_host(&self) -> &str

Returns the value of rewrite_host, or the default value if rewrite_host is unset.

pub fn rewrite_path(&self) -> &str

Returns the value of rewrite_path, or the default value if rewrite_path is unset.

pub fn rewrite_port(&self) -> u32

Returns the value of rewrite_port, or the default value if rewrite_port is unset.

impl RequestHttpFrontend

pub fn to_frontend(self) -> Result<HttpFrontend, RequestError>

convert a requested frontend to a usable one by parsing its address

Trait Implementations

impl Clone for RequestHttpFrontend

fn clone(&self) -> RequestHttpFrontend

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestHttpFrontend

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

Formats the value using the given formatter.

impl Default for RequestHttpFrontend

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RequestHttpFrontend

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RequestHttpFrontend

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

Used to create a unique summary of the frontend, used as a key in maps

impl From<HttpFrontend> for RequestHttpFrontend

fn from(val: HttpFrontend) -> Self

Converts to this type from the input type.

impl Hash for RequestHttpFrontend

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for RequestHttpFrontend

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Ord for RequestHttpFrontend

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RequestHttpFrontend

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for RequestHttpFrontend

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for RequestHttpFrontend

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RequestHttpFrontend

impl StructuralPartialEq for RequestHttpFrontend