Struct TpeResponse 

pub struct TpeResponse<'a>(/* private fields */);

Available on crate feature tpe only.

A partial version of crate::Response.

This feature is experimental. For more information see https://github.com/cedar-policy/rfcs/blob/main/README.md#experimental-features

Implementations

impl TpeResponse<'_>

pub fn decision(&self) -> Option<Decision>

Attempt to get the authorization decision

pub fn reauthorize( &self, request: &Request, entities: &Entities, ) -> Result<Response, TpeReauthorizationError>

Perform reauthorization

pub fn residual_policies(&self) -> impl Iterator<Item = Policy> + '_

Return residuals as Policys.

Each returned Policy inherits its PolicyId and annotations from the corresponding input policy. Its scope is unconstrained and its condition is a single when clause containing the residual expression.

Use TpeResponse::nontrivial_residual_policies to skip trivially true or false residuals.

The returned policies can be converted to PST for structured inspection of the residual expression tree:

let response = policy_set.tpe(&request, &entities, &schema)?;
for policy in response.residual_policies() {
    let pst_policy = policy.to_pst()?;
    for clause in pst_policy.body().clauses() {
        // inspect the residual expression via pst::Clause / pst::Expr
    }
}

pub fn nontrivial_residual_policies(&self) -> impl Iterator<Item = Policy> + '_

Returns an iterator of non-trivial (meaning more than just true or false) residuals as Policys.

Each returned Policy inherits its PolicyId and annotations from the corresponding input policy. Its scope is unconstrained and its condition is a single when clause containing the residual expression.

Call Policy::to_pst() on each result to get a crate::pst::Policy for structured inspection. Residual expressions may contain crate::pst::Expr::ResidualError nodes indicating subexpressions that would error at runtime; use crate::pst::Expr::has_error() to check.

Trait Implementations

impl<'a> Clone for TpeResponse<'a>

fn clone(&self) -> TpeResponse<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TpeResponse<'a>

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

Formats the value using the given formatter.

impl<'a> RefCast for TpeResponse<'a>

type From = Response<'a>

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self