Struct Capability 

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

Logical capabilities that a context can grant to child entities.

Each capability gates a set of operations. Operations require the corresponding capability to be present in the context.

Capability	Operations
READ	orcs.read, orcs.grep, orcs.glob
WRITE	orcs.write, orcs.mkdir
DELETE	orcs.remove, orcs.mv
EXECUTE	orcs.exec
SPAWN	orcs.spawn_child, orcs.spawn_runner
LLM	orcs.llm
HTTP	orcs.http

Implementations

impl Capability

pub const READ: Capability

Read files: orcs.read, orcs.grep, orcs.glob

pub const WRITE: Capability

Write files: orcs.write, orcs.mkdir

pub const DELETE: Capability

Delete/move files: orcs.remove, orcs.mv

pub const EXECUTE: Capability

Execute commands: orcs.exec

pub const SPAWN: Capability

Spawn children/runners: orcs.spawn_child, orcs.spawn_runner

pub const LLM: Capability

Call LLM: orcs.llm

pub const HTTP: Capability

HTTP requests: orcs.http

impl Capability

pub const fn empty() -> Capability

Get a flags value with all bits unset.

pub const fn all() -> Capability

Get a flags value with all known bits set.

pub const fn bits(&self) -> u16

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u16) -> Option<Capability>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u16) -> Capability

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u16) -> Capability

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Capability>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Capability) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Capability)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Capability)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Capability)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Capability, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Capability) -> Capability

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Capability) -> Capability

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Capability) -> Capability

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Capability) -> Capability

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Capability

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl Capability

pub const fn iter(&self) -> Iter<Capability>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<Capability>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl Capability

pub const FILE_ALL: Capability

All file operations: READ | WRITE | DELETE.

pub const ALL: Capability

All capabilities.

pub fn inherit(parent: Capability, requested: Capability) -> Capability

Computes the effective capabilities for a child.

Returns the intersection of parent and requested capabilities. A child can never exceed its parent’s capabilities.

Arguments

• parent - Parent’s capabilities
• requested - Requested capabilities for the child

Returns

parent & requested — the effective capability set.

Example

use orcs_auth::Capability;

let parent = Capability::READ | Capability::WRITE;
let requested = Capability::READ | Capability::EXECUTE;
let effective = Capability::inherit(parent, requested);
assert_eq!(effective, Capability::READ);

pub fn names(self) -> Vec<&'static str>

Returns a human-readable list of capability names.

Example

use orcs_auth::Capability;

let caps = Capability::READ | Capability::WRITE;
let names = caps.names();
assert!(names.contains(&"READ"));
assert!(names.contains(&"WRITE"));

pub fn parse(name: &str) -> Option<Capability>

Parses a capability name string (case-insensitive).

Unlike Flags::from_name (exact match), this accepts lowercase input and aliases like “EXEC” for “EXECUTE”.

Example

use orcs_auth::Capability;

assert_eq!(Capability::parse("read"), Some(Capability::READ));
assert_eq!(Capability::parse("EXECUTE"), Some(Capability::EXECUTE));
assert_eq!(Capability::parse("exec"), Some(Capability::EXECUTE));
assert_eq!(Capability::parse("http"), Some(Capability::HTTP));
assert_eq!(Capability::parse("unknown"), None);

pub fn parse_list<'a>(names: &[&'a str]) -> (Capability, Vec<&'a str>)

Parses a list of capability names into a combined set.

Returns the combined capabilities and a list of unknown names. Callers should decide how to handle unknown names (error, warn, etc.)

Example

use orcs_auth::Capability;

let (caps, unknown) = Capability::parse_list(&["READ", "WRITE"]);
assert_eq!(caps, Capability::READ | Capability::WRITE);
assert!(unknown.is_empty());

let (caps, unknown) = Capability::parse_list(&["READ", "bad"]);
assert_eq!(caps, Capability::READ);
assert_eq!(unknown, vec!["bad"]);

Trait Implementations

impl Binary for Capability

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

Formats the value using the given formatter.

impl BitAnd for Capability

fn bitand(self, other: Capability) -> Capability

The bitwise and (&) of the bits in two flags values.

type Output = Capability

The resulting type after applying the & operator.

impl BitAndAssign for Capability

fn bitand_assign(&mut self, other: Capability)

The bitwise and (&) of the bits in two flags values.

impl BitOr for Capability

fn bitor(self, other: Capability) -> Capability

The bitwise or (|) of the bits in two flags values.

type Output = Capability

The resulting type after applying the | operator.

impl BitOrAssign for Capability

fn bitor_assign(&mut self, other: Capability)

The bitwise or (|) of the bits in two flags values.

impl BitXor for Capability

fn bitxor(self, other: Capability) -> Capability

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = Capability

The resulting type after applying the ^ operator.

impl BitXorAssign for Capability

fn bitxor_assign(&mut self, other: Capability)

The bitwise exclusive-or (^) of the bits in two flags values.

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Capability, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Capability

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

Formats the value using the given formatter.

impl Extend<Capability> for Capability

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = Capability>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Flags for Capability

const FLAGS: &'static [Flag<Capability>]

The set of defined flags.

type Bits = u16

The underlying bits type.

fn bits(&self) -> u16

Get the underlying bits value.

fn from_bits_retain(bits: u16) -> Capability

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<Capability> for Capability

fn from_iter<T>(iterator: T) -> Capability

where T: IntoIterator<Item = Capability>,

The bitwise or (|) of the bits in each flags value.

impl Hash for Capability

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

where __H: Hasher,

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

type Item = Capability

The type of the elements being iterated over.

type IntoIter = Iter<Capability>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Capability as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for Capability

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

Formats the value using the given formatter.

impl Not for Capability

fn not(self) -> Capability

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = Capability

The resulting type after applying the ! operator.

impl Octal for Capability

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

Formats the value using the given formatter.

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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Capability

fn sub(self, other: Capability) -> Capability

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = Capability

The resulting type after applying the - operator.

impl SubAssign for Capability

fn sub_assign(&mut self, other: Capability)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for Capability

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

Formats the value using the given formatter.

impl Copy for Capability

impl Eq for Capability

impl StructuralPartialEq for Capability