Enum XRequestedWith 

pub enum XRequestedWith {
    XmlHttpRequest,
    Unknown(Box<str>),
}

Available on crate features http and std only.

The X-Requested-With request header.

Not a standard header, and browsers do not send it on their own. JavaScript libraries such as jQuery set it to XMLHttpRequest on the requests they make, so a server can tell a script request from a navigation. Android WebView has also sent it on its own requests, carrying the embedding app’s package name (e.g. com.example.app); such values are kept as XRequestedWith::Unknown.

Matching is ASCII case-insensitive; encoding emits the canonical spelling of a known value.

Example

use rama_http_headers::{HeaderMapExt, XRequestedWith};
use rama_http_types::HeaderMap;

let mut headers = HeaderMap::new();
headers.insert("x-requested-with", "xmlhttprequest".parse().unwrap());
assert_eq!(headers.typed_get(), Some(XRequestedWith::XmlHttpRequest));

headers.typed_insert(XRequestedWith::XmlHttpRequest);
assert_eq!(headers["x-requested-with"], "XMLHttpRequest");

Variants

XmlHttpRequest

XMLHttpRequest: a request made from script.

Unknown(Box<str>)

Retains an unrecognized value.

Implementations

impl XRequestedWith

pub fn as_str(&self) -> &str

pub fn as_static_str(&self) -> Cow<'static, str>

pub fn as_smol_str(&self) -> SmolStr

pub fn strict_parse(s: &str) -> Option<XRequestedWith>

Parse a known value, or return None. It ignores ASCII case and surrounding whitespace, unless the enum is #[case_sensitive].

Trait Implementations

impl Clone for XRequestedWith

fn clone(&self) -> XRequestedWith

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XRequestedWith

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for XRequestedWith

fn deserialize<D>( deserializer: D, ) -> Result<XRequestedWith, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for XRequestedWith

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

Formats the value using the given formatter.

impl Eq for XRequestedWith

impl<'a> From<&'a str> for XRequestedWith

fn from(s: &'a str) -> XRequestedWith

Converts to this type from the input type.

impl From<String> for XRequestedWith

fn from(s: String) -> XRequestedWith

Converts to this type from the input type.

impl FromStr for XRequestedWith

type Err = !

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<XRequestedWith, !>

Parses a string s to return a value of this type.

impl Hash for XRequestedWith

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl HeaderDecode for XRequestedWith

fn decode<'i, I>(values: &mut I) -> Result<XRequestedWith, Error>

where I: Iterator<Item = &'i HeaderValue>,

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for XRequestedWith

fn encode<E>(&self, values: &mut E)

where E: Extend<HeaderValue>,

Encode this type to a HeaderValue, and add it to a container which has HeaderValue type as each element.

fn encode_to_value(&self) -> Option<HeaderValue>

Encode this header to HeaderValue.

impl PartialEq for XRequestedWith

fn eq(&self, other: &XRequestedWith) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for XRequestedWith

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for XRequestedWith

impl TypedHeader for XRequestedWith

fn name() -> &'static HeaderName

The name of this header.