Crate praxis_filter 

Filter pipeline engine for Praxis.

Re-exports

pub use body::BodyAccess;

pub use body::BodyBuffer;

pub use body::BodyBufferOverflow;

pub use body::BodyCapabilities;

pub use body::BodyMode;

pub use builtins::CircuitBreakerFilter;

pub use builtins::ContainsValue;

pub use builtins::CredentialInjectionFilter;

pub use builtins::DisallowedOriginMode;

pub use builtins::GuardrailsAction;

pub use builtins::GuardrailsFilter;

pub use builtins::LoadBalancerFilter;

pub use builtins::PiiKind;

pub use builtins::RateLimitMode;

pub use builtins::RedirectStatus;

pub use builtins::RouterFilter;

pub use builtins::RuleTargetKind;

pub use builtins::has_dot_dot_traversal;

pub use builtins::normalize_rewritten_path;

Modules

body

Body access declarations, buffering, and capability computation.

builtins

Built-in filter implementations, organized by protocol and category.

Macros

export_filters

Macro for exporting filters from an external crate for build-time auto-discovery.

register_filters

Macro for registering custom filters alongside built-ins.

Structs

CompressionConfig

Compression settings extracted from the filter for use by the protocol handler when registering Pingora’s compression module.

FilterEntry

A single filter in the pipeline.

FilterPipeline

An ordered list of filters executed on every request.

FilterRegistry

Registry of available filter types.

FilterResultSet

Result feedback from a single filter execution.

HttpFilterContext

Per-request mutable state shared across all HTTP filters.

Rejection

A filter rejection response.

Request

HTTP request metadata.

RequestExtensions

Type-safe, request-scoped extension container.

Response

HTTP response metadata.

TcpFilterContext

Per-connection state for TCP filters.

Enums

AnyFilter

A filter of any protocol level, for storage in a pipeline.

FailureMode

Per-filter failure behaviour.

FilterAction

Result of a filter’s request or response processing.

FilterFactory

A protocol-tagged filter factory.

Traits

HttpFilter

A filter that participates in HTTP request/response processing.

PipelineExtension

Injects pipeline-scoped resources into per-request extensions.

TcpFilter

A filter that participates in TCP connection processing.

Functions

http_builtin

Wrap a builtin HTTP filter factory function.

parse_filter_config

Parse a YAML config value into a typed config struct.

should_execute

Returns true if the filter should execute given its conditions.

should_execute_response

Returns true if the filter should execute in the response phase.

should_execute_response_ref

Evaluate response conditions against borrowed status and headers.

tcp_builtin

Wrap a builtin TCP filter factory function.

Type Aliases

Filter

Backward-compatible alias for HttpFilter.

FilterContext

Backward-compatible alias for HttpFilterContext.

FilterError

Boxed error type for filter results.

HttpFilterFactory

Factory function for creating HTTP filters from config.

TcpFilterFactory

Factory function for creating TCP filters from config.