Struct gotham::router::route::matcher::ContentTypeHeaderRouteMatcher

pub struct ContentTypeHeaderRouteMatcher { /* private fields */ }

A RouteMatcher that succeeds when the Request has been made with a Content-Type header that includes a supported media type. The matcher will fail if the Content-Type header is missing, unless you call allow_no_type on it.

Examples

let supported_media_types = vec![mime::APPLICATION_JSON];
let matcher = ContentTypeHeaderRouteMatcher::new(supported_media_types);

// No content type header
state.put(HeaderMap::new());
assert!(matcher.is_match(&state).is_err());

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

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

// At least one supported content type header
let mut headers = HeaderMap::new();
headers.insert(CONTENT_TYPE, "text/plain".parse().unwrap());
headers.insert(CONTENT_TYPE, "application/json".parse().unwrap());
state.put(headers);
assert!(matcher.is_match(&state).is_ok());

Implementations

impl ContentTypeHeaderRouteMatcher

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

Creates a new ContentTypeHeaderRouteMatcher that does not allow requests that don’t include a content-type header.

pub fn allow_no_type(self) -> Self

Modify this matcher to allow requests that don’t include a content-type header.

Trait Implementations

impl Clone for ContentTypeHeaderRouteMatcher

fn clone(&self) -> ContentTypeHeaderRouteMatcher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl RouteMatcher for ContentTypeHeaderRouteMatcher

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

Determines if the Request was made using a Content-Type header that includes a supported media type.