Struct Location

pub struct Location {
    pub name: String,
    pub key: String,
    pub upstream: String,
    pub proxy_add_headers: Option<Vec<HttpHeader>>,
    pub proxy_set_headers: Option<Vec<HttpHeader>>,
    pub plugins: Option<Vec<String>>,
    pub enable_reverse_proxy_headers: bool,
    /* 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: String

Unique identifier for this location configuration

key: String

Hash key used for configuration versioning and change detection

upstream: String

Target upstream server where requests will be proxied to

proxy_add_headers: Option<Vec<HttpHeader>>

Additional headers to append to proxied requests These are added without removing existing headers

proxy_set_headers: Option<Vec<HttpHeader>>

Headers to set on proxied requests These override any existing headers with the same name

plugins: Option<Vec<String>>

Ordered list of plugin names to execute during request/response processing

enable_reverse_proxy_headers: bool

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

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 client_body_size_limit(&self, payload_size: usize) -> Result<(), Error>

Sets the maximum allowed size of the client request body. If the size in a request exceeds the configured value, the 413 (Request Entity Too Large) error is returned to the client.

pub fn add_processing(&self) -> Result<(u64, i32), Error>

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).

pub fn sub_processing(&self)

Decrements the processing request counter for this location.

This method is called when a request finishes being processed. It performs an atomic decrement of the currently processing requests counter.

pub fn match_host_path( &self, host: &str, path: &str, ) -> (bool, Option<Vec<(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 rewrite( &self, header: &mut RequestHeader, variables: Option<&AHashMap<String, String>>, ) -> bool

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

Trait Implementations

impl Debug for Location

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

Formats the value using the given formatter.