Struct HttpModuleCtx 

pub struct HttpModuleCtx { /* private fields */ }

The Contexts of multiple modules

This is the object that will apply all the included modules to a certain HTTP request. The modules are ordered according to their order().

Implementations

impl HttpModuleCtx

pub fn empty() -> HttpModuleCtx

Create a placeholder empty HttpModuleCtx.

HttpModules should be used to create nonempty HttpModuleCtx.

pub fn get<T>(&self) -> Option<&T>

where T: 'static,

Get a ref to HttpModule if any.

pub fn get_mut<T>(&mut self) -> Option<&mut T>

where T: 'static,

Get a mut ref to HttpModule if any.

pub async fn request_header_filter( &mut self, req: &mut RequestHeader, ) -> Result<(), Box<Error>>

Run the request_header_filter for all the modules according to their orders.

pub async fn request_body_filter( &mut self, body: &mut Option<Bytes>, end_of_stream: bool, ) -> Result<(), Box<Error>>

Run the request_body_filter for all the modules according to their orders.

pub async fn response_header_filter( &mut self, req: &mut ResponseHeader, end_of_stream: bool, ) -> Result<(), Box<Error>>

Run the response_header_filter for all the modules according to their orders.

pub fn response_body_filter( &mut self, body: &mut Option<Bytes>, end_of_stream: bool, ) -> Result<(), Box<Error>>

Run the response_body_filter for all the modules according to their orders.

pub fn response_trailer_filter( &mut self, trailers: &mut Option<Box<HeaderMap>>, ) -> Result<Option<Bytes>, Box<Error>>

Run the response_trailer_filter for all the modules according to their orders.

Returns an Option<Bytes> which can be used to write response trailers into the response body. Note, if multiple modules attempt to write trailers into the body the last one will be used.

Implementors that intend to write trailers into the body need to ensure their filter is using an encoding that supports this.

pub fn response_done_filter(&mut self) -> Result<Option<Bytes>, Box<Error>>

Run the response_done_filter for all the modules according to their orders.

This filter may be invoked in certain response paths to signal end of response if not already done so via trailers or body (with end flag set).

Returns an Option<Bytes> which can be used to write additional response body bytes. Note, if multiple modules attempt to write body bytes, only the last one will be used.