Struct Location 

pub struct Location {
    pub name: Arc<str>,
    pub key: String,
    pub headers: Option<Vec<(HeaderName, HeaderValue, bool)>>,
    pub plugins: Option<Vec<String>>,
    pub max_retries: Option<u8>,
    pub max_retry_window: Option<Duration>,
    /* private fields */
}

Location represents a routing configuration for handling HTTP requests. It defines rules for matching requests based on paths and hosts, and specifies how these requests should be processed and proxied.

Fields

name: Arc<str>

Unique identifier for this location configuration

key: String

Hash key used for configuration versioning and change detection

headers: Option<Vec<(HeaderName, HeaderValue, bool)>>

Headers to set or append on proxied requests

plugins: Option<Vec<String>>

Additional headers to append to proxied requests These are added without removing existing headers Headers to set on proxied requests These override any existing headers with the same name Ordered list of plugin names to execute during request/response processing

max_retries: Option<u8>

Whether to automatically add standard reverse proxy headers like: X-Forwarded-For, X-Real-IP, X-Forwarded-Proto, etc. Maximum window for retries

max_retry_window: Option<Duration>

Maximum window for retries

Implementations

impl Location

pub fn new(name: &str, conf: &LocationConf) -> Result<Location, Error>

Creates a new Location from configuration Validates and compiles path/host patterns and other settings

pub fn support_grpc_web(&self) -> bool

Returns whether gRPC-Web protocol support is enabled for this location When enabled, the proxy will handle gRPC-Web requests and convert them to regular gRPC

pub fn validate_content_length( &self, header: &RequestHeader, ) -> Result<(), Error>

Validates that the request’s Content-Length header does not exceed the configured maximum

Arguments

• header - The HTTP request header to validate

Returns

• Result<()> - Ok if validation passes, Error::BodyTooLarge if content length exceeds limit

Notes

• Returns Ok if client_max_body_size is 0 (unlimited)
• Uses get_content_length() helper to parse the Content-Length header

pub fn match_host_path( &self, host: &str, path: &str, ) -> (bool, Option<AHashMap<String, String>>)

Checks if a request matches this location’s path and host rules Returns a tuple containing:

• bool: Whether the request matched both path and host rules
• Option<Vec<(String, String)>>: Any captured variables from regex host matching

pub fn stats(&self) -> LocationStats

Trait Implementations

impl Debug for Location

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

Formats the value using the given formatter.

impl LocationInstance for Location

fn on_request(&self) -> Result<(u64, i32)>

Increments the processing and accepted request counters for this location.

This method is called when a new request starts being processed by this location. It performs two atomic operations:

1. Increments the total accepted requests counter
2. Increments the currently processing requests counter

Returns

• Result<(u64, i32)> - A tuple containing:
  • The new total number of accepted requests (u64)
  • The new number of currently processing requests (i32)

Errors

Returns Error::TooManyRequest if the number of currently processing requests would exceed the configured max_processing limit (when non-zero).

fn rewrite( &self, header: &mut RequestHeader, variables: Option<AHashMap<String, String>>, ) -> (bool, Option<AHashMap<String, String>>)

Applies URL rewriting rules if configured for this location.

This method performs path rewriting based on regex patterns and replacement rules. It supports variable interpolation from captured values in the host matching.

Arguments

• header - Mutable reference to the request header containing the URI to rewrite
• variables - Optional map of variables captured from host matching that can be interpolated into the replacement value

Returns

• bool - Returns true if the path was rewritten, false if no rewriting was performed

Examples

// Configuration example:
// rewrite: "^/users/(.*)$ /api/users/$1"
// This would rewrite "/users/123" to "/api/users/123"

Notes

• Preserves query parameters when rewriting the path
• Logs debug information about path rewrites
• Logs errors if the new path cannot be parsed as a valid URI

fn name(&self) -> &str

Get location’s name

fn headers(&self) -> Option<&Vec<(HeaderName, HeaderValue, bool)>>

Returns the proxy header to upstream

fn client_body_size_limit(&self) -> usize

Returns the client body size limit

fn upstream(&self) -> &str

Get the upstream of location

fn on_response(&self)

Called when the response is received from the upstream