Enum scratchstack_aspen::Action

pub enum Action {
    Any,
    Specific(SpecificActionDetails),
}

An action in an Aspen policy.

This can either be Any action (represented by the string *), or a service and an API pattern (Specific) in the form service:api_pattern. The API pattern may contain wildcard characters (* and ?).

Variants

Any

Any action.

Specific(SpecificActionDetails)

A specific action.

Implementations

impl Action

pub fn new<S: Into<String>, A: Into<String>>(
    service: S,
    api: A
) -> Result<Self, AspenError>

Create a new Action::Specific action.

Errors

An AspenError::InvalidAction error is returned in any of the following cases:

• service or api is empty.
• service contains non-ASCII alphanumeric characters, hyphen (-), or underscore (_).
• service begins or ends with a hyphen or underscore.
• api contains non-ASCII alphanumeric characters, hyphen (-), underscore (_), asterisk (*), or question mark (?).
• api begins or ends with a hyphen or underscore.

pub fn is_any(&self) -> bool

Returns true if this action is Action::Any.

pub fn specific(&self) -> Option<(&str, &str)>

If the action is Action::Specific, returns the service and action.

pub fn service(&self) -> &str

Returns the service for this action or “*” if this action is Action::Any.

pub fn api(&self) -> &str

Returns the API for this action or “*” if this action is Action::Any.

pub fn matches(&self, service: &str, api: &str) -> bool

Indicates whether this action matches the given service and action.

Trait Implementations

impl Clone for Action

fn clone(&self) -> Action

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Action

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

Formats the value using the given formatter.

impl Display for Action

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

Formats the value using the given formatter.

impl FromStr for Action

type Err = AspenError

The associated error which can be returned from parsing.

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

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

impl PartialEq<Action> for Action

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Action