Enum cedar_policy::EvaluationErrorKind

pub enum EvaluationErrorKind {
    EntityDoesNotExist(Arc<EntityUID>),
    EntityAttrDoesNotExist {
        entity: Arc<EntityUID>,
        attr: SmolStr,
    },
    UnspecifiedEntityAccess(SmolStr),
    RecordAttrDoesNotExist(SmolStr, Vec<SmolStr>),
    FailedExtensionFunctionLookup(ExtensionFunctionLookupError),
    TypeError {
        expected: Vec<Type>,
        actual: Type,
    },
    WrongNumArguments {
        function_name: Name,
        expected: usize,
        actual: usize,
    },
    IntegerOverflow(IntegerOverflowError),
    InvalidRestrictedExpression(RestrictedExprError),
    UnlinkedSlot(SlotId),
    FailedExtensionFunctionApplication {
        extension_name: Name,
        msg: String,
    },
    NonValue(Expr),
    RecursionLimit,
}

Enumeration of the possible errors that can occur during evaluation

Variants

EntityDoesNotExist(Arc<EntityUID>)

Tried to lookup this entity UID, but it didn’t exist in the provided entities

EntityAttrDoesNotExist

Tried to get this attribute, but the specified entity didn’t have that attribute

Fields

entity: Arc<EntityUID>

Entity that didn’t have the attribute

attr: SmolStr

Name of the attribute it didn’t have

UnspecifiedEntityAccess(SmolStr)

Tried to access an attribute of an unspecified entity

RecordAttrDoesNotExist(SmolStr, Vec<SmolStr>)

Tried to get an attribute of a (non-entity) record, but that record didn’t have that attribute

FailedExtensionFunctionLookup(ExtensionFunctionLookupError)

An error occurred when looking up an extension function

TypeError

Tried to evaluate an operation on values with incorrect types for that operation

Fields

expected: Vec<Type>

Expected (one of) these types

actual: Type

Encountered this type instead

WrongNumArguments

Wrong number of arguments provided to an extension function

Fields

function_name: Name

arguments to this function

expected: usize

expected number of arguments

actual: usize

actual number of arguments

IntegerOverflow(IntegerOverflowError)

Overflow during an integer operation

InvalidRestrictedExpression(RestrictedExprError)

Error with the use of “restricted” expressions

UnlinkedSlot(SlotId)

Thrown when a policy is evaluated with a slot that is not linked to an EntityUID

FailedExtensionFunctionApplication

Evaluation error thrown by an extension function

Fields

extension_name: Name

Name of the extension throwing the error

msg: String

Error message from the extension

NonValue(Expr)

This error is raised if an expression contains unknowns and cannot be reduced to a Value. In order to return partial results, use the partial evaluation APIs instead.

RecursionLimit

Maximum recursion limit reached for expression evaluation

Trait Implementations

impl Clone for EvaluationErrorKind

fn clone(&self) -> EvaluationErrorKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EvaluationErrorKind

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

Formats the value using the given formatter.

impl Diagnostic for EvaluationErrorKind

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn related(&self) -> Option<Box<dyn Iterator<Item = &dyn Diagnostic> + '_>>

Additional related Diagnostics.

fn url(&self) -> Option<Box<dyn Display + '_>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for EvaluationErrorKind

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

Formats the value using the given formatter.

impl Error for EvaluationErrorKind

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type based access to context intended for error reports.

impl From<ExtensionFunctionLookupError> for EvaluationErrorKind

fn from(source: ExtensionFunctionLookupError) -> EvaluationErrorKind

Converts to this type from the input type.

impl From<IntegerOverflowError> for EvaluationErrorKind

fn from(source: IntegerOverflowError) -> EvaluationErrorKind

Converts to this type from the input type.

impl From<RestrictedExprError> for EvaluationErrorKind

fn from(source: RestrictedExprError) -> EvaluationErrorKind

Converts to this type from the input type.

impl PartialEq for EvaluationErrorKind

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

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

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 EvaluationErrorKind

impl StructuralPartialEq for EvaluationErrorKind