Struct CapabilitySet 

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

A set of capabilities held by a plugin instance.

Membership tests are O(1) on average.

Examples

use martensite_plugin::{Capability, CapabilitySet};

let mut caps = CapabilitySet::empty();
caps.grant(Capability::Network);
assert!(caps.contains(&Capability::Network));
caps.revoke(&Capability::Network);
assert!(!caps.contains(&Capability::Network));

Implementations

impl CapabilitySet

pub fn empty() -> Self

Creates an empty capability set.

Examples

use martensite_plugin::CapabilitySet;

let caps = CapabilitySet::empty();
assert!(caps.is_empty());

pub fn builder() -> PluginBuilder

Returns a builder for constructing a capability set fluently.

Examples

use martensite_plugin::{Capability, CapabilitySet};

let caps = CapabilitySet::builder().grant(Capability::Network).build();
assert!(caps.contains(&Capability::Network));

pub fn len(&self) -> usize

Returns the number of distinct capabilities in the set.

Examples

use martensite_plugin::{Capability, CapabilitySet};

let mut caps = CapabilitySet::empty();
assert_eq!(caps.len(), 0);
caps.grant(Capability::Network);
assert_eq!(caps.len(), 1);

pub fn is_empty(&self) -> bool

Returns true if no capabilities have been granted.

Examples

use martensite_plugin::CapabilitySet;

let caps = CapabilitySet::empty();
assert!(caps.is_empty());

pub fn grant(&mut self, cap: Capability) -> bool

Grants a capability, returning true if it was newly inserted.

Examples

use martensite_plugin::{Capability, CapabilitySet};

let mut caps = CapabilitySet::empty();
assert!(caps.grant(Capability::Network));
assert!(!caps.grant(Capability::Network)); // already granted

pub fn revoke(&mut self, cap: &Capability) -> bool

Revokes a capability, returning true if it was present.

Examples

use martensite_plugin::{Capability, CapabilitySet};

let mut caps = CapabilitySet::empty();
caps.grant(Capability::Network);
assert!(caps.revoke(&Capability::Network));
assert!(!caps.revoke(&Capability::Network)); // already revoked

pub fn contains(&self, cap: &Capability) -> bool

Returns true if the capability is currently granted.

Examples

use martensite_plugin::{Capability, CapabilitySet};

let mut caps = CapabilitySet::empty();
caps.grant(Capability::Network);
assert!(caps.contains(&Capability::Network));

pub fn file_read_allowed(&self, requested_path: &Path) -> bool

Returns true if a file_read request for requested_path is authorized by any granted Capability::FileRead entry.

Authorization is performed by canonicalizing both the granted roots and the requested path, then requiring the requested path to be equal to, or descend into, at least one granted root. This defeats path-traversal attacks (/assets/../etc/passwd) that exact-match checks would otherwise miss when a directory is granted and a child file is requested.

When the requested file does not exist on disk (so std::fs::canonicalize fails), the path is normalized lexically via std::path::Path::components stripping of . and resolving .. against the granted root, and the prefix check is applied to the normalized form. This keeps the check total (no filesystem dependency) while still rejecting .. escapes.

Granting a directory (e.g. FileRead("/assets")) authorizes reads of any file beneath it (e.g. /assets/textures/foo.png). Granting a file authorizes only that exact file.

Examples

use martensite_plugin::{Capability, CapabilitySet};
use std::path::Path;

let mut caps = CapabilitySet::empty();
caps.grant(Capability::FileRead("/assets".into()));
assert!(caps.file_read_allowed(Path::new("/assets/foo.txt")));
assert!(!caps.file_read_allowed(Path::new("/etc/passwd")));

pub fn file_write_allowed(&self, requested_path: &Path) -> bool

Returns true if a file_write request for requested_path is authorized by any granted Capability::FileWrite entry. See Self::file_read_allowed for canonicalization semantics.

Examples

use martensite_plugin::{Capability, CapabilitySet};
use std::path::Path;

let mut caps = CapabilitySet::empty();
caps.grant(Capability::FileWrite("/tmp/log".into()));
assert!(caps.file_write_allowed(Path::new("/tmp/log")));
assert!(!caps.file_write_allowed(Path::new("/etc/passwd")));

Trait Implementations

impl Clone for CapabilitySet

fn clone(&self) -> CapabilitySet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CapabilitySet

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

Formats the value using the given formatter.

impl Default for CapabilitySet

fn default() -> CapabilitySet

Returns the “default value” for a type.

impl Eq for CapabilitySet

impl PartialEq for CapabilitySet

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CapabilitySet