Struct Capability 

pub struct Capability {
    pub scope: String,
    pub actions: Vec<Action>,
}

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

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

Fields

scope: String

Scope of resources (e.g. a directory or file). Must start with /.

actions: Vec<Action>

Allowed actions within scope. Serialized as a compact action string (e.g. "rw").

Implementations

impl Capability

pub fn root() -> Self

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

Equivalent to Capability { scope: "/".into(), actions: vec![Read, Write] }.

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

pub fn read<S: Into<String>>(scope: S) -> Self

Construct a read-only capability for scope.

The scope is normalized to start with / if it does not already.

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

pub fn write<S: Into<String>>(scope: S) -> Self

Construct a write-only capability for scope.

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

pub fn read_write<S: Into<String>>(scope: S) -> Self

Construct a read+write capability for scope.

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

pub fn builder<S: Into<String>>(scope: S) -> CapabilityBuilder

Start building a single capability for scope.

The scope is normalized to have a leading /.

use pubky_common::capabilities::Capability;
let cap = Capability::builder("pub/my.app").read().finish();
assert_eq!(cap.to_string(), "/pub/my.app:r");

Trait Implementations

impl Clone for Capability

fn clone(&self) -> Capability

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 FromStr for Capability

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.

impl PartialEq for Capability

fn eq(&self, other: &Capability) -> 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 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 TryFrom<&str> for Capability

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

Parse "<scope>:<actions>". Scope must start with /; actions must be valid letters.

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

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<String> for Capability

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Capability

impl StructuralPartialEq for Capability