Struct gotham::router::route::matcher::accept::AcceptHeaderRouteMatcher

pub struct AcceptHeaderRouteMatcher { /* private fields */ }

A RouteMatcher that succeeds when the Request has been made with an Accept header that includes one or more supported media types. A missing Accept header, or the value of */* will also positvely match. It supports the quality weighted syntax, but does not take the quality into consideration when matching.

Examples

let supported_media_types = vec![mime::APPLICATION_JSON, mime::IMAGE_STAR];
let matcher = AcceptHeaderRouteMatcher::new(supported_media_types);

// No accept header
state.put(HeaderMap::new());
assert!(matcher.is_match(&state).is_ok());

// Accept header of `*/*`
let mut headers = HeaderMap::new();
headers.insert(ACCEPT, "*/*".parse().unwrap());
state.put(headers);
assert!(matcher.is_match(&state).is_ok());

// Accept header of `application/json`
let mut headers = HeaderMap::new();
headers.insert(ACCEPT, "application/json".parse().unwrap());
state.put(headers);
assert!(matcher.is_match(&state).is_ok());

// Not a valid Accept header
let mut headers = HeaderMap::new();
headers.insert(ACCEPT, "text/plain".parse().unwrap());
state.put(headers);
assert!(matcher.is_match(&state).is_err());

// At least one supported accept header
let mut headers = HeaderMap::new();
headers.insert(ACCEPT, "text/plain".parse().unwrap());
headers.insert(ACCEPT, "application/json".parse().unwrap());
state.put(headers);
assert!(matcher.is_match(&state).is_ok());
// Accept header of `image/*`
let mut headers = HeaderMap::new();
headers.insert(ACCEPT, "image/*".parse().unwrap());
state.put(headers);
assert!(matcher.is_match(&state).is_ok());

Implementations

impl AcceptHeaderRouteMatcher

pub fn new(supported_media_types: Vec<Mime>) -> Self

Creates a new AcceptHeaderRouteMatcher

Trait Implementations

impl Clone for AcceptHeaderRouteMatcher

fn clone(&self) -> AcceptHeaderRouteMatcher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl RouteMatcher for AcceptHeaderRouteMatcher

fn is_match(&self, state: &State) -> Result<(), RouteNonMatch>

Determines if the Request was made using an Accept header that includes one or more supported media types. A missing Accept header, or the value of */* will also positvely match.

Quality values within Accept header values are not considered by the matcher, as the matcher is only able to indicate whether a successful match has been found.