Struct Capabilities 

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

A wrapper around Vec<Capability> that controls how capabilities are serialized and built.

Serialization is a single comma-separated string (e.g. "/:rw,/pub/my-cool-app/:r"), which is convenient for logs, URLs, or compact text payloads. It also comes with a fluent builder (Capabilities::builder()).

Note: this does not remove length prefixes in binary encodings; if you need a varint-free trailing field in a custom binary format, implement a bespoke encoder/decoder instead of serde.

Implementations

impl Capabilities

pub fn normalize(self) -> Self

Return a normalized capability list.

Normalization merges duplicate scopes, de-duplicates and sorts actions, and removes capabilities already covered by broader capabilities.

Examples

use pubky_common::capabilities::{Capability, Capabilities};

let caps = Capabilities::from(vec![
    Capability::read("/pub/").unwrap(),
    Capability::write("/pub/").unwrap(),
    Capability::read("/pub/file.txt").unwrap(),
]);

assert_eq!(caps.normalize().to_string(), "/pub/:rw");

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

Returns true if the list contains capability.

pub fn is_empty(&self) -> bool

Returns true if the list is empty.

pub fn len(&self) -> usize

Returns the number of entries.

pub fn iter(&self) -> Iter<'_, Capability>

Returns an iterator over the slice of Capability.

pub fn builder() -> CapsBuilder

Start a fluent builder for multiple capabilities.

use pubky_common::capabilities::Capabilities;
let caps = Capabilities::builder().read_write("/").unwrap().finish();
assert_eq!(caps.to_string(), "/:rw");

pub fn try_from_caps_url(url: &Url) -> Result<Self, CapabilitiesParseError>

Parse capabilities from the caps query parameter of url.

Expects a comma-separated list of capability strings, e.g.: ?caps=/pub/my-cool-app/:rw,/foo:r

Examples

let url = Url::parse("https://example/app?caps=/pub/my-cool-app/:rw,/foo:r").unwrap();
let caps = Capabilities::try_from_caps_url(&url).unwrap();
assert!(!caps.is_empty());

pub fn as_slice(&self) -> &[Capability]

Borrow the inner capabilities as a slice without allocating.

Constant-time; returns a view into the existing buffer.

Examples

use pubky_common::capabilities::{Capability, Capabilities};

let caps = Capabilities::from(vec![
    Capability::read("/foo").unwrap(),
    Capability::write("/bar/").unwrap(),
]);
let slice: &[Capability] = caps.as_slice();
assert_eq!(slice.len(), 2);

pub fn to_vec(&self) -> Vec<Capability>

Clone the inner capability list.

Trait Implementations

impl Clone for Capabilities

fn clone(&self) -> Capabilities

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Capabilities

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

Formats the value using the given formatter.

impl Default for Capabilities

fn default() -> Capabilities

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Capabilities

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Capabilities

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

Formats the value using the given formatter.

impl Eq for Capabilities

impl From<Capabilities> for Vec<Capability>

fn from(value: Capabilities) -> Self

Converts to this type from the input type.

impl From<Vec<Capability>> for Capabilities

fn from(value: Vec<Capability>) -> Self

Converts to this type from the input type.

impl FromStr for Capabilities

type Err = CapabilitiesParseError

The associated error which can be returned from parsing.

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

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

impl PartialEq for Capabilities

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Capabilities

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 Capabilities

impl TryFrom<&str> for Capabilities

type Error = CapabilitiesParseError

The type returned in the event of a conversion error.

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

Performs the conversion.