Enum HoopConfig 

pub enum HoopConfig {
    RateLimit {
        window: Duration,
        max: u64,
        burst: Option<u64>,
    },
    ForwardAuth {
        url: String,
        copy_headers: Vec<String>,
    },
    Encode {
        encodings: Vec<String>,
        level: Option<u32>,
    },
    Headers(HeadersConfig),
    BasicAuth {
        users: Vec<BasicAuthUser>,
        brute_force_max: Option<u32>,
        brute_force_window: Option<Duration>,
    },
    IpFilter {
        allow: Vec<String>,
        deny: Vec<String>,
        forwarded_for: bool,
    },
    Rewrite {
        strip_prefix: Option<String>,
        uri: Option<String>,
        regex_rules: Vec<(String, String)>,
        if_not_file: bool,
        if_not_dir: bool,
        root: Option<String>,
        normalize_slashes: bool,
    },
    Replace {
        rules: Vec<(String, String)>,
        once: bool,
    },
    Cache(CacheConfig),
    Templates {
        root: Option<String>,
    },
    BufferLimit {
        max_request_body: Option<usize>,
        max_response_body: Option<usize>,
    },
    Cors {
        allow_origins: Vec<String>,
        allow_methods: Vec<String>,
        allow_headers: Vec<String>,
        allow_credentials: bool,
        expose_headers: Vec<String>,
        max_age: Option<u64>,
    },
    Timeout {
        duration: Duration,
    },
    RequestId {
        header_name: Option<String>,
        overwrite: bool,
    },
    ForceHttps {
        https_port: Option<u16>,
    },
    TrailingSlash {
        action: String,
    },
    Decompress {
        max_size: Option<usize>,
    },
    ErrorPages {
        pages: HashMap<u16, String>,
    },
    StreamReplace {
        rules: Vec<(String, String)>,
        once: bool,
    },
    Module {
        name: String,
        config: HashMap<String, String>,
    },
}

Supported middleware configurations.

Variants

RateLimit

Fields

window: Duration

max: u64

burst: Option<u64>

Maximum burst capacity (token bucket ceiling). Defaults to max when not specified.

ForwardAuth

Fields

url: String

URL of the authentication service to delegate to.

copy_headers: Vec<String>

Headers from the auth response to copy into the original request.

Encode

Fields

encodings: Vec<String>

level: Option<u32>

Headers(HeadersConfig)

BasicAuth

Fields

users: Vec<BasicAuthUser>

brute_force_max: Option<u32>

Maximum number of consecutive failures before an IP is locked out. Defaults to 5 when None.

brute_force_window: Option<Duration>

Duration of the lockout period after exceeding brute_force_max. Defaults to 300 seconds when None.

IpFilter

Fields

allow: Vec<String>

deny: Vec<String>

forwarded_for: bool

When true, use the first IP in the X-Forwarded-For header instead of the direct client address.

Rewrite

Fields

strip_prefix: Option<String>

uri: Option<String>

regex_rules: Vec<(String, String)>

Regex rewrite rules: list of (pattern, replacement) pairs applied sequentially to the path.

if_not_file: bool

Only rewrite when the resolved path does NOT correspond to an existing file on disk (requires root).

if_not_dir: bool

Only rewrite when the resolved path does NOT correspond to an existing directory on disk (requires root).

root: Option<String>

Filesystem root used by if_not_file / if_not_dir checks.

normalize_slashes: bool

When true, collapse consecutive slashes in the path before applying any other rewrite rules (e.g. //foo///bar → /foo/bar).

Replace

Fields

rules: Vec<(String, String)>

List of (search, replacement) pairs applied to the response body.

once: bool

If true, only replace the first occurrence of each search string.

Cache(CacheConfig)

Templates

Fields

root: Option<String>

BufferLimit

Fields

max_request_body: Option<usize>

Maximum allowed request body size in bytes. Returns 413 when exceeded.

max_response_body: Option<usize>

Maximum allowed response body size in bytes. Returns 502 when exceeded.

Cors

Fields

allow_origins: Vec<String>

Allowed origins. Use ["*"] to allow any origin.

allow_methods: Vec<String>

Allowed HTTP methods. Use ["*"] to allow any method.

allow_headers: Vec<String>

Allowed request headers. Use ["*"] to allow any header.

allow_credentials: bool

Whether to allow credentials (cookies, authorization headers).

expose_headers: Vec<String>

Headers to expose to the browser.

max_age: Option<u64>

How long (in seconds) the preflight response can be cached.

Timeout

Fields

duration: Duration

Maximum duration for a request before returning 503.

RequestId

Fields

header_name: Option<String>

Header name for the request ID. Defaults to "x-request-id".

overwrite: bool

Whether to overwrite an existing request ID. Defaults to true.

ForceHttps

Fields

https_port: Option<u16>

HTTPS port to redirect to. If not set, uses the default (443).

TrailingSlash

Fields

action: String

Action: "add" or "remove".

Decompress

Fields

max_size: Option<usize>

Maximum decompressed body size in bytes. Prevents decompression bombs.

ErrorPages

Fields

pages: HashMap<u16, String>

Maps HTTP status code to custom body content.

StreamReplace

Fields

rules: Vec<(String, String)>

List of (search, replacement) pairs applied to the streaming response body.

once: bool

If true, only replace the first occurrence of each search string.

Module

A module-provided middleware loaded via the plugin system.

Fields

name: String

Module name (matches a registered ModuleLoader).

config: HashMap<String, String>

Module-specific configuration as key-value pairs.

Trait Implementations

impl Clone for HoopConfig

fn clone(&self) -> HoopConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HoopConfig

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

Formats the value using the given formatter.

impl Serialize for HoopConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.