Struct GrantAtom 

pub struct GrantAtom {
    pub domain: String,
    pub action: String,
    pub resource: String,
}

One permission, as domain:action:resource.

For example fs:read:/src/**, net:egress:api.example.com:443, or secret:use:stripe_key. The resource may be omitted for permissions that take no argument, giving the two-part form time:now or rand:bytes.

A resource may be a template such as {path}, resolved at runtime and clamped to the statically computed envelope, so a dynamic value can only ever narrow the grant, never widen it.

Fields

domain: String

The resource family: fs, net, proc, env, secret, time, rand.

action: String

What may be done: read, write, egress, exec, use.

resource: String

What it applies to. May contain globs or {template} segments, and may be empty for permissions that take no argument.

Implementations

impl GrantAtom

pub fn new( domain: impl Into<String>, action: impl Into<String>, resource: impl Into<String>, ) -> Self

Build an atom from its three parts.

pub fn is_template(&self) -> bool

Whether the resource contains a {template} segment to be resolved at runtime.

Templates stay symbolic through grant inference; the compiler reasons about the envelope they are clamped to rather than the value.

pub fn is_bare(&self) -> bool

Whether this permission takes no resource argument, as time:now does.

pub fn has_known_domain(&self) -> bool

Whether the domain is one the specification documents.

A false here is not an error — see KNOWN_DOMAINS.

Trait Implementations

impl Clone for GrantAtom

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 GrantAtom

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GrantAtom

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for GrantAtom

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

Formats the value using the given formatter.

impl Eq for GrantAtom

impl FromIterator<GrantAtom> for GrantSet

fn from_iter<I: IntoIterator<Item = GrantAtom>>(iter: I) -> Self

Creates a value from an iterator.

impl FromStr for GrantAtom

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

Parse domain:action[:resource].

Splits on the first two colons only, so a resource may itself contain colons — net:egress:api.example.com:443 is one atom whose resource is api.example.com:443, not a malformed four-part atom.

type Err = GrantAtomParseError

The associated error which can be returned from parsing.

impl Hash for GrantAtom

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 GrantAtom

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 GrantAtom

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for GrantAtom

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 GrantAtom

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 GrantAtom