pub struct AcceptHeaderRouteMatcher { /* private fields */ }
Expand description

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

Creates a new AcceptHeaderRouteMatcher

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

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.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The concrete RouteMatcher each implementation will provide.

Transform into a RouteMatcher of the the associated type identified by Output.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more