Struct FetchMetadata 

pub struct FetchMetadata {
    pub site: Option<SecFetchSite>,
    pub mode: Option<SecFetchMode>,
    pub dest: Option<SecFetchDest>,
    pub user: bool,
}

Available on crate features http and std only.

The Fetch Metadata request headers of a request, read together.

This is a view over SecFetchSite, SecFetchMode, SecFetchDest and SecFetchUser, not a TypedHeader of its own: it spans four header names. A header that is absent or fails to decode leaves its field empty, so a partial set (some embedded browsers only send Sec-Fetch-Site) still yields the fields that were sent.

Example

use rama_http_headers::{FetchMetadata, SecFetchDest, SecFetchMode, SecFetchSite};
use rama_http_types::HeaderMap;

let navigation = FetchMetadata::default()
    .with_site(SecFetchSite::None)
    .with_mode(SecFetchMode::Navigate)
    .with_dest(SecFetchDest::Document)
    .with_user(true);

let mut headers = HeaderMap::new();
navigation.insert_into(&mut headers);
assert_eq!(headers["sec-fetch-user"], "?1");

assert_eq!(FetchMetadata::from_headers(&headers), Some(navigation));
assert_eq!(FetchMetadata::from_headers(&HeaderMap::new()), None);

Fields

site: Option<SecFetchSite>

The Sec-Fetch-Site header.

mode: Option<SecFetchMode>

The Sec-Fetch-Mode header.

dest: Option<SecFetchDest>

The Sec-Fetch-Dest header.

user: bool

Whether the Sec-Fetch-User header was sent, marking a navigation triggered by user activation.

Implementations

impl FetchMetadata

pub fn from_headers(headers: &HeaderMap) -> Option<FetchMetadata>

Read the fetch metadata headers from headers.

Returns None when none of them is present with a valid value: a non-browser client, or a browser too old to send them. That is a different answer from “sent, with these values”.

pub fn insert_into(&self, headers: &mut HeaderMap)

Write this metadata into headers.

Present fields replace their header; absent fields remove it, so the map carries exactly this metadata afterwards.

pub fn is_empty(&self) -> bool

Whether no field is set.

pub fn maybe_with_site(self, site: Option<SecFetchSite>) -> FetchMetadata

Set the Sec-Fetch-Site value.

pub fn maybe_set_site( &mut self, site: Option<SecFetchSite>, ) -> &mut FetchMetadata

Set the Sec-Fetch-Site value.

pub fn with_site(self, site: SecFetchSite) -> FetchMetadata

Set the Sec-Fetch-Site value.

pub fn set_site(&mut self, site: SecFetchSite) -> &mut FetchMetadata

Set the Sec-Fetch-Site value.

pub fn without_site(self) -> FetchMetadata

Set the Sec-Fetch-Site value.

pub fn unset_site(&mut self) -> &mut FetchMetadata

Set the Sec-Fetch-Site value.

pub fn maybe_with_mode(self, mode: Option<SecFetchMode>) -> FetchMetadata

Set the Sec-Fetch-Mode value.

pub fn maybe_set_mode( &mut self, mode: Option<SecFetchMode>, ) -> &mut FetchMetadata

Set the Sec-Fetch-Mode value.

pub fn with_mode(self, mode: SecFetchMode) -> FetchMetadata

Set the Sec-Fetch-Mode value.

pub fn set_mode(&mut self, mode: SecFetchMode) -> &mut FetchMetadata

Set the Sec-Fetch-Mode value.

pub fn without_mode(self) -> FetchMetadata

Set the Sec-Fetch-Mode value.

pub fn unset_mode(&mut self) -> &mut FetchMetadata

Set the Sec-Fetch-Mode value.

pub fn maybe_with_dest(self, dest: Option<SecFetchDest>) -> FetchMetadata

Set the Sec-Fetch-Dest value.

pub fn maybe_set_dest( &mut self, dest: Option<SecFetchDest>, ) -> &mut FetchMetadata

Set the Sec-Fetch-Dest value.

pub fn with_dest(self, dest: SecFetchDest) -> FetchMetadata

Set the Sec-Fetch-Dest value.

pub fn set_dest(&mut self, dest: SecFetchDest) -> &mut FetchMetadata

Set the Sec-Fetch-Dest value.

pub fn without_dest(self) -> FetchMetadata

Set the Sec-Fetch-Dest value.

pub fn unset_dest(&mut self) -> &mut FetchMetadata

Set the Sec-Fetch-Dest value.

pub fn with_user(self, user: bool) -> FetchMetadata

Set whether the request was triggered by user activation (Sec-Fetch-User).

pub fn set_user(&mut self, user: bool) -> &mut FetchMetadata

Set whether the request was triggered by user activation (Sec-Fetch-User).

Trait Implementations

impl Clone for FetchMetadata

fn clone(&self) -> FetchMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FetchMetadata

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

Formats the value using the given formatter.

impl Default for FetchMetadata

fn default() -> FetchMetadata

Returns the “default value” for a type.

impl Eq for FetchMetadata

impl Hash for FetchMetadata

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<State> OptionalFromPartsStateRefPair<State> for FetchMetadata

where State: Send + Sync,

type Rejection = !

If the extractor fails, it will use this “rejection” type.

async fn from_parts_state_ref_pair( parts: &Parts, _state: &State, ) -> Result<Option<FetchMetadata>, <FetchMetadata as OptionalFromPartsStateRefPair<State>>::Rejection>

Perform the extraction.

impl PartialEq for FetchMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FetchMetadata