Struct CapAttrs 

pub struct CapAttrs {
    pub methods: BTreeSet<String>,
    pub budget: Budget,
    pub read_only: bool,
    pub redact: bool,
    pub path_scope: Option<String>,
    pub tool_policy: Option<ToolPolicy>,
}

The authority a capability carries.

Fields

methods: BTreeSet<String>

Granted method names. Must be non-empty after attenuation.

budget: Budget

Resource budget.

read_only: bool

May not mutate module state.

redact: bool

Redacts trace output.

path_scope: Option<String>

Dotted path prefix the capability is confined to (inclusive).

tool_policy: Option<ToolPolicy>

Tool policy, when the capability targets a tool.

Implementations

impl CapAttrs

pub fn new(methods: &[&str]) -> Self

Full authority over methods with the default budget.

pub fn with_methods(self, methods: &[&str]) -> Self

Restrict methods.

pub fn with_budget(self, budget: Budget) -> Self

Restrict the budget.

pub fn with_path(self, path: impl Into<String>) -> Self

Confine the capability to a path prefix.

pub fn read_only(self) -> Self

Mark the capability read-only.

pub fn redacted(self) -> Self

Mark the capability redacting.

pub fn with_tool_policy(self, policy: ToolPolicy) -> Self

Attach a tool policy.

pub fn is_attenuation_of(&self, parent: &CapAttrs) -> bool

True when self is a valid attenuation of parent.

pub fn attenuate(&self, child: CapAttrs) -> Result<CapAttrs>

Attenuate, refusing anything that would widen authority.

pub fn grants(&self, method: &str) -> bool

Whether method is granted.

pub fn covers_path(&self, path: &str) -> bool

Whether path is inside the capability’s scope.

Trait Implementations

impl Clone for CapAttrs

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CapAttrs

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

Formats the value using the given formatter.

impl Eq for CapAttrs

impl PartialEq for CapAttrs

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CapAttrs