Enum cedar_policy_core::entities::EntitySchemaConformanceError

pub enum EntitySchemaConformanceError {
    UnexpectedEntityAttr {
        uid: EntityUID,
        attr: SmolStr,
    },
    MissingRequiredEntityAttr {
        uid: EntityUID,
        attr: SmolStr,
    },
    TypeMismatch {
        uid: EntityUID,
        attr: SmolStr,
        err: TypeMismatchError,
    },
    HeterogeneousSet {
        uid: EntityUID,
        attr: SmolStr,
        err: HeterogeneousSetError,
    },
    InvalidAncestorType {
        uid: EntityUID,
        ancestor_ty: Box<EntityType>,
    },
    UnexpectedEntityType(UnexpectedEntityTypeError),
    UndeclaredAction {
        uid: EntityUID,
    },
    ActionDeclarationMismatch {
        uid: EntityUID,
    },
    ExtensionFunctionLookup {
        uid: EntityUID,
        attr: SmolStr,
        err: ExtensionFunctionLookupError,
    },
}

Errors raised when entities do not conform to the schema

Variants

UnexpectedEntityAttr

Fields

uid: EntityUID

Entity that had the unexpected attribute

attr: SmolStr

Name of the attribute that was unexpected

Encountered attribute that shouldn’t exist on entities of this type

MissingRequiredEntityAttr

Fields

uid: EntityUID

Entity that is missing a required attribute

attr: SmolStr

Name of the attribute which was expected

Didn’t encounter attribute that should exist

TypeMismatch

Fields

uid: EntityUID

Entity where the type mismatch occurred

attr: SmolStr

Name of the attribute where the type mismatch occurred

err: TypeMismatchError

Underlying error

The given attribute on the given entity had a different type than the schema indicated

HeterogeneousSet

Fields

uid: EntityUID

Entity where the error occurred

attr: SmolStr

Name of the attribute where the error occurred

err: HeterogeneousSetError

Underlying error

Found a set whose elements don’t all have the same type. This doesn’t match any possible schema.

InvalidAncestorType

Fields

uid: EntityUID

Entity that has an invalid ancestor type

ancestor_ty: Box<EntityType>

Ancestor type which was invalid

Found an ancestor of a type that’s not allowed for that entity

UnexpectedEntityType(UnexpectedEntityTypeError)

Encountered an entity of a type which is not declared in the schema. Note that this error is only used for non-Action entity types.

UndeclaredAction

Fields

uid: EntityUID

Action which was not declared in the schema

Encountered an action which was not declared in the schema

ActionDeclarationMismatch

Fields

uid: EntityUID

Action whose definition mismatched between entity data and schema

Encountered an action whose definition doesn’t precisely match the schema’s declaration of that action

ExtensionFunctionLookup

Fields

uid: EntityUID

Entity where the error occurred

attr: SmolStr

Name of the attribute where the error occurred

err: ExtensionFunctionLookupError

Underlying error

Error looking up an extension function. This error can occur when checking entity conformance because that may require getting information about any extension functions referenced in entity attribute values.

Trait Implementations

impl Debug for EntitySchemaConformanceError

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

Formats the value using the given formatter.

impl Diagnostic for EntitySchemaConformanceError

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 EntitySchemaConformanceError

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

Formats the value using the given formatter.

impl Error for EntitySchemaConformanceError

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<EntitySchemaConformanceError> for EntitiesError

fn from(source: EntitySchemaConformanceError) -> Self

Converts to this type from the input type.

impl From<UnexpectedEntityTypeError> for EntitySchemaConformanceError

fn from(source: UnexpectedEntityTypeError) -> Self

Converts to this type from the input type.