Struct Scope 

pub struct Scope { /* private fields */ }

A validated capability scope in service:resource:action form.

Serializes as a plain string, so the wire representation is a flat array of strings rather than a nested structure.

Examples

use agent_capability_token::Scope;

let scope: Scope = "tools:calendar:invoke".parse()?;
assert_eq!(scope.service(), "tools");
assert_eq!(scope.action(), "invoke");

// A granted wildcard covers a specific request.
let granted: Scope = "runtime:platform:*".parse()?;
let requested: Scope = "runtime:platform:spawn".parse()?;
assert!(granted.covers(&requested));

Implementations

impl Scope

pub fn parse(value: impl Into<String>) -> ActResult<Self>

Parses and validates a scope string.

Errors

Returns ActError::MalformedScope unless the input has exactly three non-empty colon-separated segments.

pub fn service(&self) -> &str

The service segment.

pub fn resource(&self) -> &str

The resource segment.

pub fn action(&self) -> &str

The action segment.

pub fn as_str(&self) -> &str

The scope as it appears on the wire.

pub fn covers(&self, requested: &Self) -> bool

Whether this scope, treated as a grant, authorizes requested.

A WILDCARD segment in the grant matches any value in the same position. The comparison is directional: a wildcard in requested is matched literally, so a caller cannot widen its own authority by asking for *.

Trait Implementations

impl Clone for Scope

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 Scope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Scope

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

Deserialize this value from the given Serde deserializer.

impl Display for Scope

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

Formats the value using the given formatter.

impl Eq for Scope

impl FromStr for Scope

type Err = ActError

The associated error which can be returned from parsing.

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

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

impl Hash for Scope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Scope

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Scope

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Scope

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Scope

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Scope