Struct PermissionsPolicy 

pub struct PermissionsPolicy { /* private fields */ }

Permissions-Policy response header.

Adding a directive that already exists in the policy replaces its allow-list in place (preserving declared order). The user agent would treat the second occurrence as the winner per RFC 8941 structured-fields anyway, so we collapse to the caller-most-recent value.

Examples

Deny the common ambient-capability features:

use rama_http_headers::PermissionsPolicy;

let pp = PermissionsPolicy::empty()
    .with_deny_camera()
    .with_deny_microphone()
    .with_deny_geolocation()
    .with_deny_payment()
    .with_deny_usb()
    .with_deny_interest_cohort();

let rendered = pp.to_string();
assert!(rendered.contains("camera=()"));
assert!(rendered.contains("interest-cohort=()"));

Drop down to the generic surface for an allow-list or for a proposed/draft feature that isn’t yet modelled:

use rama_http_headers::{
    PermissionsPolicy, PermissionsPolicyDirective, PermissionsPolicyDirectiveName,
    AllowlistSource,
};

let pp = PermissionsPolicy::empty()
    .with_directive(PermissionsPolicyDirective::allow(
        PermissionsPolicyDirectiveName::Camera,
        AllowlistSource::SelfOrigin,
    ))
    .with_directive(PermissionsPolicyDirective::deny(
        // Unknown / vendor / draft feature names land in the
        // auto-generated `Unknown` variant via `From<&str>`.
        PermissionsPolicyDirectiveName::from("x-vendor-experimental"),
    ));
assert_eq!(pp.to_string(), "camera=(self), x-vendor-experimental=()");

Implementations

impl PermissionsPolicy

pub const fn empty() -> Self

Empty policy. Build from this when adding directives one at a time.

pub fn directives( &self, ) -> impl Iterator<Item = &PermissionsPolicyDirective> + '_

Iterate the policy’s directives in encoding order.

pub fn with_directive(self, directive: PermissionsPolicyDirective) -> Self

Generic escape hatch: append or replace a directive by name. If a directive with the same name exists, its allow-list is overwritten in place (order preserved); otherwise it’s appended.

The macro generates the &mut self sibling set_directive.

pub fn set_directive( &mut self, directive: PermissionsPolicyDirective, ) -> &mut Self

Generic escape hatch: append or replace a directive by name. If a directive with the same name exists, its allow-list is overwritten in place (order preserved); otherwise it’s appended.

The macro generates the &mut self sibling set_directive.

pub fn with_deny_camera(self) -> Self

Set camera=() (deny-all).

pub fn set_deny_camera(&mut self) -> &mut Self

Set camera=() (deny-all).

pub fn with_deny_microphone(self) -> Self

Set microphone=() (deny-all).

pub fn set_deny_microphone(&mut self) -> &mut Self

Set microphone=() (deny-all).

pub fn with_deny_geolocation(self) -> Self

Set geolocation=() (deny-all).

pub fn set_deny_geolocation(&mut self) -> &mut Self

Set geolocation=() (deny-all).

pub fn with_deny_payment(self) -> Self

Set payment=() (deny-all).

pub fn set_deny_payment(&mut self) -> &mut Self

Set payment=() (deny-all).

pub fn with_deny_usb(self) -> Self

Set usb=() (deny-all).

pub fn set_deny_usb(&mut self) -> &mut Self

Set usb=() (deny-all).

pub fn with_deny_interest_cohort(self) -> Self

Set interest-cohort=() (deny-all). Opts the site out of the deprecated FLoC experiment. Pair with deny_browsing_topics to also block Topics API, FLoC’s shipped successor.

pub fn set_deny_interest_cohort(&mut self) -> &mut Self

Set interest-cohort=() (deny-all). Opts the site out of the deprecated FLoC experiment. Pair with deny_browsing_topics to also block Topics API, FLoC’s shipped successor.

pub fn with_deny_browsing_topics(self) -> Self

Set browsing-topics=() (deny-all). Opts the site out of the Topics API (Privacy Sandbox).

pub fn set_deny_browsing_topics(&mut self) -> &mut Self

Set browsing-topics=() (deny-all). Opts the site out of the Topics API (Privacy Sandbox).

pub fn with_deny_attribution_reporting(self) -> Self

Set attribution-reporting=() (deny-all). Opts the site out of the Attribution Reporting API (Privacy Sandbox).

pub fn set_deny_attribution_reporting(&mut self) -> &mut Self

Set attribution-reporting=() (deny-all). Opts the site out of the Attribution Reporting API (Privacy Sandbox).

pub fn with_deny_accelerometer(self) -> Self

Set accelerometer=() (deny-all).

pub fn set_deny_accelerometer(&mut self) -> &mut Self

Set accelerometer=() (deny-all).

pub fn with_deny_ambient_light_sensor(self) -> Self

Set ambient-light-sensor=() (deny-all).

pub fn set_deny_ambient_light_sensor(&mut self) -> &mut Self

Set ambient-light-sensor=() (deny-all).

pub fn with_deny_autoplay(self) -> Self

Set autoplay=() (deny-all).

pub fn set_deny_autoplay(&mut self) -> &mut Self

Set autoplay=() (deny-all).

pub fn with_deny_battery(self) -> Self

Set battery=() (deny-all).

pub fn set_deny_battery(&mut self) -> &mut Self

Set battery=() (deny-all).

pub fn with_deny_bluetooth(self) -> Self

Set bluetooth=() (deny-all).

pub fn set_deny_bluetooth(&mut self) -> &mut Self

Set bluetooth=() (deny-all).

pub fn with_deny_display_capture(self) -> Self

Set display-capture=() (deny-all).

pub fn set_deny_display_capture(&mut self) -> &mut Self

Set display-capture=() (deny-all).

pub fn with_deny_encrypted_media(self) -> Self

Set encrypted-media=() (deny-all).

pub fn set_deny_encrypted_media(&mut self) -> &mut Self

Set encrypted-media=() (deny-all).

pub fn with_deny_fullscreen(self) -> Self

Set fullscreen=() (deny-all).

pub fn set_deny_fullscreen(&mut self) -> &mut Self

Set fullscreen=() (deny-all).

pub fn with_deny_gyroscope(self) -> Self

Set gyroscope=() (deny-all).

pub fn set_deny_gyroscope(&mut self) -> &mut Self

Set gyroscope=() (deny-all).

pub fn with_deny_idle_detection(self) -> Self

Set idle-detection=() (deny-all).

pub fn set_deny_idle_detection(&mut self) -> &mut Self

Set idle-detection=() (deny-all).

pub fn with_deny_magnetometer(self) -> Self

Set magnetometer=() (deny-all).

pub fn set_deny_magnetometer(&mut self) -> &mut Self

Set magnetometer=() (deny-all).

pub fn with_deny_midi(self) -> Self

Set midi=() (deny-all).

pub fn set_deny_midi(&mut self) -> &mut Self

Set midi=() (deny-all).

pub fn with_deny_picture_in_picture(self) -> Self

Set picture-in-picture=() (deny-all).

pub fn set_deny_picture_in_picture(&mut self) -> &mut Self

Set picture-in-picture=() (deny-all).

pub fn with_deny_publickey_credentials_get(self) -> Self

Set publickey-credentials-get=() (deny-all).

pub fn set_deny_publickey_credentials_get(&mut self) -> &mut Self

Set publickey-credentials-get=() (deny-all).

pub fn with_deny_screen_wake_lock(self) -> Self

Set screen-wake-lock=() (deny-all).

pub fn set_deny_screen_wake_lock(&mut self) -> &mut Self

Set screen-wake-lock=() (deny-all).

pub fn with_deny_sync_xhr(self) -> Self

Set sync-xhr=() (deny-all).

pub fn set_deny_sync_xhr(&mut self) -> &mut Self

Set sync-xhr=() (deny-all).

pub fn with_deny_web_share(self) -> Self

Set web-share=() (deny-all).

pub fn set_deny_web_share(&mut self) -> &mut Self

Set web-share=() (deny-all).

pub fn with_deny_xr_spatial_tracking(self) -> Self

Set xr-spatial-tracking=() (deny-all).

pub fn set_deny_xr_spatial_tracking(&mut self) -> &mut Self

Set xr-spatial-tracking=() (deny-all).

Trait Implementations

impl Clone for PermissionsPolicy

fn clone(&self) -> PermissionsPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PermissionsPolicy

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

Formats the value using the given formatter.

impl Default for PermissionsPolicy

fn default() -> PermissionsPolicy

Returns the “default value” for a type.

impl Display for PermissionsPolicy

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

Formats the value using the given formatter.

impl Eq for PermissionsPolicy

impl HeaderDecode for PermissionsPolicy

fn decode<'i, I: Iterator<Item = &'i HeaderValue>>( values: &mut I, ) -> Result<Self, Error>

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for PermissionsPolicy

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

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 PermissionsPolicy

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

impl TypedHeader for PermissionsPolicy

fn name() -> &'static HeaderName

The name of this header.