Struct SecPurpose 

pub struct SecPurpose { /* private fields */ }

Available on crate features http and std only.

The Sec-Purpose request header.

Sent by browsers on a speculative request: something fetched before the user asked for it. The header is a Structured Field List (RFC 9651) with a member that is the token prefetch, optionally with parameters:

• prefetch: <link rel=prefetch> or a speculation-rules prefetch.
• prefetch;prerender: a speculation-rules prerender, or one the browser started itself (e.g. from the address bar).
• prefetch;anonymous-client-ip: a prefetch sent through a private prefetch proxy, hiding the client’s IP address.

A parameter is set by any value but ?0, and unknown parameters are ignored. Several field lines combine into one List. The first prefetch member is read, wherever it is; without one, a first member that is another token (prefetch matches case-sensitively) is kept as SecPurposeKind::Unknown, and anything else is invalid.

The legacy spellings Purpose: prefetch, X-Purpose: preview (Safari) and X-Moz: prefetch (older Firefox) are separate headers this type does not read.

It is not one of the Fetch Metadata headers, but describes the same request context; FetchMetadata carries it alongside them.

Example

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

let mut headers = HeaderMap::new();
headers.typed_insert(SecPurpose::prerender());
assert_eq!(headers["sec-purpose"], "prefetch;prerender");

let purpose: SecPurpose = headers.typed_get().unwrap();
assert!(purpose.is_prefetch());
assert!(purpose.is_prerender());
assert!(!purpose.anonymous_client_ip());

Implementations

impl SecPurpose

pub const fn new(kind: SecPurposeKind) -> SecPurpose

A purpose of kind, without parameters.

pub const fn prefetch() -> SecPurpose

prefetch: a speculative fetch of a resource or document.

pub const fn prerender() -> SecPurpose

prefetch;prerender: a speculative fetch that is also rendered.

pub fn kind(&self) -> &SecPurposeKind

The purpose token.

pub fn is_prefetch(&self) -> bool

Whether the purpose token is prefetch.

A prerender is a prefetch on the wire, so this holds for it as well.

pub const fn is_prerender(&self) -> bool

Whether the prerender parameter is set: the browser renders the response in the background, running its scripts.

pub const fn anonymous_client_ip(&self) -> bool

Whether the anonymous-client-ip parameter is set: the request went through a private prefetch proxy, so the peer address is the proxy’s, not the client’s.

pub const fn with_prerender(self, prerender: bool) -> SecPurpose

Set the prerender parameter.

pub fn set_prerender(&mut self, prerender: bool) -> &mut SecPurpose

Set the prerender parameter.

pub const fn with_anonymous_client_ip( self, anonymous_client_ip: bool, ) -> SecPurpose

Set the anonymous-client-ip parameter.

pub fn set_anonymous_client_ip( &mut self, anonymous_client_ip: bool, ) -> &mut SecPurpose

Set the anonymous-client-ip parameter.

Trait Implementations

impl Clone for SecPurpose

fn clone(&self) -> SecPurpose

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecPurpose

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecPurpose

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecPurpose

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

Formats the value using the given formatter.

impl Eq for SecPurpose

impl FromStr for SecPurpose

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<SecPurpose, <SecPurpose as FromStr>::Err>

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

impl Hash for SecPurpose

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 SecPurpose

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

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

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for SecPurpose

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 SecPurpose

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SecPurpose

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 SecPurpose

impl TypedHeader for SecPurpose

fn name() -> &'static HeaderName

The name of this header.