Struct HeaderFilter 

pub struct HeaderFilter { /* private fields */ }

Adds, sets, or removes headers on upstream requests and downstream responses.

YAML configuration

filter: headers
request_add:
  - name: X-Forwarded-By
    value: praxis
request_set:
  - name: X-Custom-Auth
    value: bearer-token
request_remove:
  - X-Internal-Only
response_add:
  - name: X-Frame-Options
    value: DENY
response_remove:
  - X-Backend-Server
response_set:
  - name: Server
    value: praxis

Example

use praxis_filter::HeaderFilter;

let yaml: serde_yaml::Value = serde_yaml::from_str(
    r#"
response_set:
  - name: Server
    value: praxis
"#,
)
.unwrap();
let filter = HeaderFilter::from_config(&yaml).unwrap();
assert_eq!(filter.name(), "headers");

Implementations

impl HeaderFilter

pub fn from_config(config: &Value) -> Result<Box<dyn HttpFilter>, FilterError>

Create a header filter from parsed YAML config.

Errors

Returns FilterError if the YAML config is invalid.

Trait Implementations

impl HttpFilter for HeaderFilter

fn name(&self) -> &'static str

Unique name identifying this filter type (e.g. "router", "rate_limit").

fn on_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, ctx: &'life1 mut HttpFilterContext<'life2>, ) -> Pin<Box<dyn Future<Output = Result<FilterAction, FilterError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called for each incoming request, in pipeline order.

fn on_response<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, ctx: &'life1 mut HttpFilterContext<'life2>, ) -> Pin<Box<dyn Future<Output = Result<FilterAction, FilterError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called for each response, in reverse pipeline order.

fn request_body_access(&self) -> BodyAccess

Declares what access this filter needs to request bodies.

fn response_body_access(&self) -> BodyAccess

Declares what access this filter needs to response bodies.

fn request_body_mode(&self) -> BodyMode

Declares the delivery mode for request body chunks.

fn response_body_mode(&self) -> BodyMode

Declares the delivery mode for response body chunks.

fn needs_request_context(&self) -> bool

Whether this filter needs the original request context during body phases.

fn apply_insecure_options(&self, _options: &InsecureOptions)

Apply global InsecureOptions to this filter.

fn compression_config(&self) -> Option<&CompressionConfig>

Returns the compression configuration if this filter enables response compression.

fn on_request_body<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, ctx: &'life1 mut HttpFilterContext<'life2>, body: &'life3 mut Option<Bytes>, end_of_stream: bool, ) -> Pin<Box<dyn Future<Output = Result<FilterAction, FilterError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Called for each chunk of request body data, in pipeline order.

fn on_response_body( &self, ctx: &mut HttpFilterContext<'_>, body: &mut Option<Bytes>, end_of_stream: bool, ) -> Result<FilterAction, FilterError>

Called for each chunk of response body data, in reverse pipeline order.