Struct gotham::router::route::matcher::AcceptHeaderRouteMatcher [−][src]
pub struct AcceptHeaderRouteMatcher { /* fields omitted */ }
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
Trait Implementations
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
impl RefUnwindSafe for AcceptHeaderRouteMatcher
impl Send for AcceptHeaderRouteMatcher
impl Sync for AcceptHeaderRouteMatcher
impl Unpin for AcceptHeaderRouteMatcher
impl UnwindSafe for AcceptHeaderRouteMatcher
Blanket Implementations
Mutably borrows from an owned value. Read more
type Output = M
type Output = M
The concrete RouteMatcher each implementation will provide.
Transform into a RouteMatcher
of the the associated type identified by Output
.
pub fn vzip(self) -> V
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