Struct ReferrerPolicy 

pub struct ReferrerPolicy(/* private fields */);

Available on crate feature http only.

Referrer-Policy header, part of Referrer Policy

The Referrer-Policy HTTP header specifies the referrer policy that the user agent applies when determining what referrer information should be included with requests made, and with browsing contexts created from the context of the protected resource.

Fallback chains

Per the Referrer Policy spec § 3.2 the wire form is 1#policy-token — a comma-separated list where the user agent walks RIGHT-TO-LEFT and picks the last token it recognises. This lets a server ship a modern policy with a fallback for older clients:

use rama_http_headers::ReferrerPolicy;

// Emits: `no-referrer, strict-origin-when-cross-origin`.
// A pre-CSP3 browser falls back to `no-referrer`; a modern browser
// picks `strict-origin-when-cross-origin`.
let rp = ReferrerPolicy::NO_REFERRER
    .with_fallback(ReferrerPolicy::STRICT_ORIGIN_WHEN_CROSS_ORIGIN);

with_fallback appends; emitted order is preserved on the wire (oldest-known first → newest-known last).

ABNF

Referrer-Policy: 1#policy-token
policy-token   = "no-referrer" / "no-referrer-when-downgrade"
                 / "same-origin" / "origin"
                 / "origin-when-cross-origin" / "unsafe-url"
                 / "strict-origin" / "strict-origin-when-cross-origin"

Example values

• no-referrer
• no-referrer, strict-origin-when-cross-origin

Example

use rama_http_headers::ReferrerPolicy;

let rp = ReferrerPolicy::NO_REFERRER;

Implementations

impl ReferrerPolicy

pub const NO_REFERRER: ReferrerPolicy

no-referrer

pub const NO_REFERRER_WHEN_DOWNGRADE: ReferrerPolicy

no-referrer-when-downgrade

pub const SAME_ORIGIN: ReferrerPolicy

same-origin

pub const ORIGIN: ReferrerPolicy

origin

pub const ORIGIN_WHEN_CROSS_ORIGIN: ReferrerPolicy

origin-when-cross-origin

pub const UNSAFE_URL: ReferrerPolicy

unsafe-url

pub const STRICT_ORIGIN: ReferrerPolicy

strict-origin

pub const STRICT_ORIGIN_WHEN_CROSS_ORIGIN: ReferrerPolicy

strict-origin-when-cross-origin

pub fn with_fallback(self, policy: ReferrerPolicy) -> ReferrerPolicy

Append a fallback policy.

Multiple calls compound; emitted order is preserved on the wire (oldest-known first → newest-known last). Browsers walk right-to-left and select the last token they recognise, so the appended policy is the one a modern client will pick — call this on your older / pre-CSP3 baseline and pass the modern token you want.

The argument’s full policy list is appended in order (so chaining preserves any fallback chain it already carried).

pub fn set_fallback(&mut self, policy: ReferrerPolicy) -> &mut ReferrerPolicy

Append a fallback policy.

Multiple calls compound; emitted order is preserved on the wire (oldest-known first → newest-known last). Browsers walk right-to-left and select the last token they recognise, so the appended policy is the one a modern client will pick — call this on your older / pre-CSP3 baseline and pass the modern token you want.

The argument’s full policy list is appended in order (so chaining preserves any fallback chain it already carried).

Trait Implementations

impl Clone for ReferrerPolicy

fn clone(&self) -> ReferrerPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReferrerPolicy

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

Formats the value using the given formatter.

impl Eq for ReferrerPolicy

impl Hash for ReferrerPolicy

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 ReferrerPolicy

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

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

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for ReferrerPolicy

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 ReferrerPolicy

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ReferrerPolicy

impl TypedHeader for ReferrerPolicy

fn name() -> &'static HeaderName

The name of this header.