rama::http::headers

Struct PermissionsPolicy

pub struct PermissionsPolicy { /* private fields */ }

Available on crate feature http only.

Expand description

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() -> PermissionsPolicy

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, ) -> PermissionsPolicy

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 PermissionsPolicy

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) -> PermissionsPolicy

Set camera=() (deny-all).

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

Set camera=() (deny-all).

pub fn with_deny_microphone(self) -> PermissionsPolicy

Set microphone=() (deny-all).

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

Set microphone=() (deny-all).

pub fn with_deny_geolocation(self) -> PermissionsPolicy

Set geolocation=() (deny-all).

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

Set geolocation=() (deny-all).

pub fn with_deny_payment(self) -> PermissionsPolicy

Set payment=() (deny-all).

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

Set payment=() (deny-all).

pub fn with_deny_usb(self) -> PermissionsPolicy

Set usb=() (deny-all).

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

Set usb=() (deny-all).

pub fn with_deny_interest_cohort(self) -> PermissionsPolicy

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 PermissionsPolicy

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.