Struct afire::extension::Head

pub struct Head { /* private fields */ }

Middleware to add support for the HTTP HEAD method. It does this by changing the method to GET and adding a special header (afire::head). Once the response is processed by the normal route handler, the middleware will check if the header is present. If it is, any body data will be discarded and the [Content-Length] header will be added, if it is not already present. On static responses, the length is already known, but with streaming responses, the stream will be read to the end to get the length (by default).

Implementations

impl Head

pub fn new() -> Self

Create a new instance of the middleware.

pub fn streaming(self, streaming: bool) -> Self

Set whether to add the Content-Length header to streaming responses.

Example

let head = Head::new().streaming(false);

Trait Implementations

impl Default for Head

fn default() -> Self

Returns the “default value” for a type.

impl Middleware for Head

fn pre(&self, req: &mut Request) -> MiddleResult

Middleware to run Before Routes

fn post(&self, req: &Request, res: &mut Response) -> MiddleResult

Middleware to run After Routes

fn pre_raw(&self, req: &mut Result<Request>) -> MiddleResult

Middleware to run before routes. Because this is the raw version of Middleware::pre, it is passed a Result. The default implementation calls Middleware::pre if the Result is Ok.

fn post_raw( &self, req: Result<Rc<Request>>, res: &mut Result<Response> ) -> MiddleResult

Middleware to run after routes. Because this is the raw version of Middleware::post, it is passed a Result. The default implementation calls Middleware::post if the Result is Ok.

fn end_raw(&self, req: &Result<Request>, res: &Result<Response>)

Middleware to run after the response has been handled. Because this is the raw version of Middleware::end, it is passed a Result. The default implementation calls Middleware::end if the Result is Ok.

fn end(&self, _req: &Request, _res: &Response)

Middleware ot run after the response has been handled

fn attach<State>(self, server: &mut Server<State>)where Self: 'static + Send + Sync + Sized, State: 'static + Send + Sync,

Attach Middleware to a Server. If you want to get a reference to the server’s state in your middleware state, you should override this method.