Struct Capability 

pub struct Capability { /* private fields */ }

A single capability: a scope and the allowed actions within it.

The wire/string representation is "<scope>:<actions>", see module docs.

Implementations

impl Capability

pub fn root() -> Self

Shorthand for a root capability at / with read+write.

Equivalent to a capability with scope / and both read and write actions.

use pubky_common::capabilities::Capability;
assert_eq!(Capability::root().to_string(), "/:rw");

pub fn read(scope: impl AsRef<str>) -> Result<Self, CapabilityParseError>

Construct a read-only capability for scope.

use pubky_common::capabilities::Capability;
assert_eq!(Capability::read("/pub/my.app").unwrap().to_string(), "/pub/my.app:r");

pub fn write(scope: impl AsRef<str>) -> Result<Self, CapabilityParseError>

Construct a write-only capability for scope.

use pubky_common::capabilities::Capability;
assert_eq!(Capability::write("/pub/tmp").unwrap().to_string(), "/pub/tmp:w");

pub fn read_write(scope: impl AsRef<str>) -> Result<Self, CapabilityParseError>

Construct a read+write capability for scope.

use pubky_common::capabilities::Capability;
assert_eq!(Capability::read_write("/").unwrap().to_string(), "/:rw");

pub fn encryption_keys( scope: impl AsRef<str>, ) -> Result<Self, CapabilityParseError>

Request scoped content keys without granting storage read or write access. Symmetric keys permit both encryption and decryption. Requires approval V1.

pub fn scope(&self) -> &StoragePath

Return the resource scope covered by this capability.

pub fn grants_encryption_keys(&self) -> bool

Whether this capability grants scoped encryption and decryption keys. Read and write permissions alone do not grant keys.

pub fn actions(&self) -> &[Action]

Return the actions allowed by this capability.

pub fn is_root(&self) -> bool

Whether this grants root storage read/write access (/:rw or /:rwe).

pub fn scope_covers_path(&self, path: &StoragePath) -> bool

Whether this capability’s scope covers the given path.

The trailing / on a scope is significant — it distinguishes a directory scope from a file scope:

• Directory scope (ends in /): covers the directory itself and any path inside it. /pub/app/ covers /pub/app/, /pub/app/foo, and /pub/app/sub/bar, but NOT /pub/app or /pub/app-evil/foo.
• File scope (no trailing /): covers only the exact path. /pub/app covers /pub/app and nothing else — not /pub/app/foo (that’s inside the directory /pub/app/, a different resource) and not /pub/app-evil (no prefix-as-string matching).

Trait Implementations

impl Clone for Capability

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 Capability

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Capability

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Capability

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

Formats the value using the given formatter.

impl Eq for Capability

impl FromStr for Capability

fn from_str(value: &str) -> Result<Self, Self::Err>

Parse "<scope>:<actions>".

use pubky_common::capabilities::Capability;
let capability: Capability = "/pub/my-cool-app/:rw".parse().unwrap();
assert_eq!(capability.to_string(), "/pub/my-cool-app/:rw");

type Err = CapabilityParseError

The associated error which can be returned from parsing.

impl PartialEq for Capability

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Capability

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Capability

impl TryFrom<&str> for Capability

type Error = CapabilityParseError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Capability

type Error = CapabilityParseError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.