Struct actix_web::guard::Acceptable

pub struct Acceptable { /* private fields */ }

A guard that verifies that an Accept header is present and it contains a compatible MIME type.

An exception is that matching */* must be explicitly enabled because most browsers send this as part of their Accept header for almost every request.

Examples

use actix_web::{guard::Acceptable, web, HttpResponse};

web::resource("/images")
    .guard(Acceptable::new(mime::IMAGE_STAR))
    .default_service(web::to(|| async {
        HttpResponse::Ok().body("only called when images responses are acceptable")
    }));

Implementations

impl Acceptable

pub fn new(mime: Mime) -> Self

Constructs new Acceptable guard with the given mime type/pattern.

pub fn match_star_star(self) -> Self

Allows */* in the Accept header to pass the guard check.

Trait Implementations

impl Clone for Acceptable

fn clone(&self) -> Acceptable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Acceptable

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

Formats the value using the given formatter.

impl Guard for Acceptable

fn check(&self, ctx: &GuardContext<'_>) -> bool

Returns true if predicate condition is met for a given request.