Struct CrossOriginEmbedderPolicy 

pub struct CrossOriginEmbedderPolicy {
    pub value: CrossOriginEmbedderPolicyValue,
    pub report_to: Option<Cow<'static, str>>,
}

Available on crate feature http only.

Cross-Origin-Embedder-Policy (COEP) header.

Send require-corp or credentialless to opt the document into process isolation suitable for using SharedArrayBuffer and other cross-origin-isolated capabilities.

The optional report-to parameter names a Reporting API endpoint (defined in the Reporting-Endpoints header) where the browser posts violation reports.

Default semantics

When the header is absent the user agent applies unsafe-none (effectively: no embedder-policy enforcement). The UnsafeNone variant represents the header being present with that explicit value — both produce the same browser behaviour but the presence is distinguishable on the wire.

Example

use rama_http_headers::{CrossOriginEmbedderPolicy, CrossOriginEmbedderPolicyValue};

let coep = CrossOriginEmbedderPolicy {
    value: CrossOriginEmbedderPolicyValue::RequireCorp,
    report_to: Some("coep-endpoint".into()),
};
assert_eq!(coep.to_string(), r#"require-corp; report-to="coep-endpoint""#);

Fields

value: CrossOriginEmbedderPolicyValue

report_to: Option<Cow<'static, str>>

; report-to="<endpoint>" — endpoint name defined in the Reporting-Endpoints header. Always emitted as a quoted sf-string per RFC 8941.

Implementations

impl CrossOriginEmbedderPolicy

pub fn unsafe_none() -> CrossOriginEmbedderPolicy

Builder shortcut: unsafe-none, no report-to.

pub fn require_corp() -> CrossOriginEmbedderPolicy

Builder shortcut: require-corp, no report-to.

pub fn credentialless() -> CrossOriginEmbedderPolicy

Builder shortcut: credentialless, no report-to.

pub fn with_report_to( self, endpoint: impl Into<Cow<'static, str>>, ) -> CrossOriginEmbedderPolicy

pub fn set_report_to( &mut self, endpoint: impl Into<Cow<'static, str>>, ) -> &mut CrossOriginEmbedderPolicy

Trait Implementations

impl Clone for CrossOriginEmbedderPolicy

fn clone(&self) -> CrossOriginEmbedderPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CrossOriginEmbedderPolicy

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

Formats the value using the given formatter.

impl Display for CrossOriginEmbedderPolicy

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

Formats the value using the given formatter.

impl Eq for CrossOriginEmbedderPolicy

impl Hash for CrossOriginEmbedderPolicy

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 CrossOriginEmbedderPolicy

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

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

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for CrossOriginEmbedderPolicy

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 CrossOriginEmbedderPolicy

fn eq(&self, other: &CrossOriginEmbedderPolicy) -> 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 CrossOriginEmbedderPolicy

impl TypedHeader for CrossOriginEmbedderPolicy

fn name() -> &'static HeaderName

The name of this header.