Struct scratchstack_aspen::Context

pub struct Context { /* private fields */ }

The request context used when evaluating an Aspen policy.

Context structures are immutable.

Implementations

impl Context

pub fn builder() -> ContextBuilder

Returns a new ContextBuilder for building a Context.

pub fn api(&self) -> &str

Returns the API being invoked.

pub fn actor(&self) -> &Principal

Returns the Principal actor making the request.

pub fn resources(&self) -> &Vec<Arn>

Returns the resources associated with the request.

pub fn session_data(&self) -> &SessionData

Returrns the session data associated with the request.

pub fn service(&self) -> &str

Returns the service being invoked.

pub fn matcher<T: AsRef<str>>(
    &self,
    s: T,
    pv: PolicyVersion,
    case_insensitive: bool
) -> Result<Regex, AspenError>

Creates a Regex from the given string pattern and policy version.

If case_insensitive is true, the returned Regex will be case insensitive.

Wildcards are converted to their regular expression equivalents. If the policy version is PolicyVersion::V2012_10_17 or later, variables are substituted and regex-escaped as necessary. The special variables ${*}, ${$}, and ${?} are converted to literal *, $, and ? characters, respectively, then regex-escaped.

Errors

If the string contains a malformed variable reference and PolicyVersion::V2012_10_17 or later is used, AspenError::InvalidSubstitution is returned.

pub fn subst_vars_plain(&self, s: &str) -> Result<String, AspenError>

Substitutes variables from the given string, returning the resulting string.

Errors

If the string contains a malformed variable reference and PolicyVersion::V2012_10_17 or later is used, AspenError::InvalidSubstitution is returned.

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Context

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

Formats the value using the given formatter.

impl PartialEq<Context> for Context

fn eq(&self, other: &Context) -> 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 Context

impl StructuralEq for Context

impl StructuralPartialEq for Context