Enum SchemaError

#[non_exhaustive]
pub enum SchemaError {
    JsonSerialization(JsonSerializationError),
    JsonDeserialization(JsonDeserializationError),
    ActionTransitiveClosure(ActionTransitiveClosureError),
    EntityTypeTransitiveClosure(EntityTypeTransitiveClosureError),
    UnsupportedFeature(UnsupportedFeatureError),
    UndeclaredEntityTypes(UndeclaredEntityTypesError),
    TypeNotDefined(TypeNotDefinedError),
    ActionNotDefined(ActionNotDefinedError),
    TypeShadowing(TypeShadowingError),
    ActionShadowing(ActionShadowingError),
    DuplicateEntityType(DuplicateEntityTypeError),
    DuplicateAction(DuplicateActionError),
    DuplicateCommonType(DuplicateCommonTypeError),
    CycleInActionHierarchy(CycleInActionHierarchyError),
    CycleInCommonTypeReferences(CycleInCommonTypeReferencesError),
    ActionEntityTypeDeclared(ActionEntityTypeDeclaredError),
    ContextOrShapeNotRecord(ContextOrShapeNotRecordError),
    ActionAttributesContainEmptySet(ActionAttributesContainEmptySetError),
    UnsupportedActionAttribute(UnsupportedActionAttributeError),
    ActionAttrEval(ActionAttrEvalError),
    ExprEscapeUsed(ExprEscapeUsedError),
    UnknownExtensionType(UnknownExtensionTypeError),
    ReservedName(ReservedNameError),
    CommonTypeInvariantViolation(CommonTypeInvariantViolationError),
    ActionInvariantViolation(ActionInvariantViolationError),
}

Error when constructing a schema

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

JsonSerialization(JsonSerializationError)

Error thrown by the serde_json crate during serialization

JsonDeserialization(JsonDeserializationError)

This error is thrown when serde_json fails to deserialize the JSON

ActionTransitiveClosure(ActionTransitiveClosureError)

Errors occurring while computing or enforcing transitive closure on action hierarchy.

EntityTypeTransitiveClosure(EntityTypeTransitiveClosureError)

Errors occurring while computing or enforcing transitive closure on entity type hierarchy.

UnsupportedFeature(UnsupportedFeatureError)

Error generated when processing a schema file that uses unsupported features

UndeclaredEntityTypes(UndeclaredEntityTypesError)

Undeclared entity type(s) used in the memberOf field of an entity type, the appliesTo fields of an action, or an attribute type in a context or entity attribute record. Entity types in the error message are fully qualified, including any implicit or explicit namespaces.

TypeNotDefined(TypeNotDefinedError)

This error occurs when we cannot resolve a typename (because it refers to an entity type or common type that was not defined).

ActionNotDefined(ActionNotDefinedError)

This error occurs when we cannot resolve an action name used in the memberOf field of an action (because it refers to an action that was not defined).

TypeShadowing(TypeShadowingError)

Entity/common type shadowing error. Some shadowing relationships are not allowed for clarity reasons; see RFC 70.

ActionShadowing(ActionShadowingError)

Action shadowing error. Some shadowing relationships are not allowed for clarity reasons; see RFC 70.

DuplicateEntityType(DuplicateEntityTypeError)

Duplicate specifications for an entity type

DuplicateAction(DuplicateActionError)

Duplicate specifications for an action

DuplicateCommonType(DuplicateCommonTypeError)

Duplicate specification for a common type declaration

CycleInActionHierarchy(CycleInActionHierarchyError)

Cycle in the schema’s action hierarchy.

CycleInCommonTypeReferences(CycleInCommonTypeReferencesError)

Cycle in the schema’s common type declarations.

ActionEntityTypeDeclared(ActionEntityTypeDeclaredError)

The schema file included an entity type Action in the entity type list. The Action entity type is always implicitly declared, and it cannot currently have attributes or be in any groups, so there is no purposes in adding an explicit entry.

ContextOrShapeNotRecord(ContextOrShapeNotRecordError)

context or shape fields are not records

ActionAttributesContainEmptySet(ActionAttributesContainEmptySetError)

An action entity (transitively) has an attribute that is an empty set. The validator cannot assign a type to an empty set. This error variant should only be used when PermitAttributes is enabled.

UnsupportedActionAttribute(UnsupportedActionAttributeError)

An action entity (transitively) has an attribute of unsupported type (ExprEscape, EntityEscape or ExtnEscape). This error variant should only be used when PermitAttributes is enabled.

ActionAttrEval(ActionAttrEvalError)

Error when evaluating an action attribute

ExprEscapeUsed(ExprEscapeUsedError)

Error thrown when the schema contains the __expr escape. Support for this escape form has been dropped.

UnknownExtensionType(UnknownExtensionTypeError)

The schema used an extension type that the validator doesn’t know about.

ReservedName(ReservedNameError)

The schema used a reserved namespace or typename (as of this writing, just __cedar).

CommonTypeInvariantViolation(CommonTypeInvariantViolationError)

Could not find a definition for a common type, at a point in the code where internal invariants should guarantee that we would find one.

ActionInvariantViolation(ActionInvariantViolationError)

Could not find a definition for an action, at a point in the code where internal invariants should guarantee that we would find one.

Implementations

impl SchemaError

pub fn join_nonempty(errs: NonEmpty<SchemaError>) -> SchemaError

Given one or more SchemaError, collect them into a single SchemaError. Due to current structures, some errors may have to be dropped in some cases.

Trait Implementations

impl Debug for SchemaError

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

Formats the value using the given formatter.

impl Diagnostic for SchemaError

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 SchemaError

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

Formats the value using the given formatter.

impl Error for SchemaError

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

Returns 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<ActionAttrEvalError> for SchemaError

fn from(source: ActionAttrEvalError) -> Self

Converts to this type from the input type.

impl From<ActionAttributesContainEmptySetError> for SchemaError

fn from(source: ActionAttributesContainEmptySetError) -> Self

Converts to this type from the input type.

impl From<ActionEntityTypeDeclaredError> for SchemaError

fn from(source: ActionEntityTypeDeclaredError) -> Self

Converts to this type from the input type.

impl From<ActionInvariantViolationError> for SchemaError

fn from(source: ActionInvariantViolationError) -> Self

Converts to this type from the input type.

impl From<ActionNotDefinedError> for SchemaError

fn from(source: ActionNotDefinedError) -> Self

Converts to this type from the input type.

impl From<ActionShadowingError> for SchemaError

fn from(source: ActionShadowingError) -> Self

Converts to this type from the input type.

impl From<ActionTransitiveClosureError> for SchemaError

fn from(source: ActionTransitiveClosureError) -> Self

Converts to this type from the input type.

impl From<CommonTypeInvariantViolationError> for SchemaError

fn from(source: CommonTypeInvariantViolationError) -> Self

Converts to this type from the input type.

impl From<ContextOrShapeNotRecordError> for SchemaError

fn from(source: ContextOrShapeNotRecordError) -> Self

Converts to this type from the input type.

impl From<CycleInActionHierarchyError> for SchemaError

fn from(source: CycleInActionHierarchyError) -> Self

Converts to this type from the input type.

impl From<CycleInCommonTypeReferencesError> for SchemaError

fn from(source: CycleInCommonTypeReferencesError) -> Self

Converts to this type from the input type.

impl From<DuplicateActionError> for SchemaError

fn from(source: DuplicateActionError) -> Self

Converts to this type from the input type.

impl From<DuplicateCommonTypeError> for SchemaError

fn from(source: DuplicateCommonTypeError) -> Self

Converts to this type from the input type.

impl From<DuplicateEntityTypeError> for SchemaError

fn from(source: DuplicateEntityTypeError) -> Self

Converts to this type from the input type.

impl From<EntityTypeTransitiveClosureError> for SchemaError

fn from(source: EntityTypeTransitiveClosureError) -> Self

Converts to this type from the input type.

impl From<ExprEscapeUsedError> for SchemaError

fn from(source: ExprEscapeUsedError) -> Self

Converts to this type from the input type.

impl From<JsonDeserializationError> for SchemaError

fn from(source: JsonDeserializationError) -> Self

Converts to this type from the input type.

impl From<JsonSerializationError> for SchemaError

fn from(source: JsonSerializationError) -> Self

Converts to this type from the input type.

impl From<ReservedNameError> for SchemaError

fn from(source: ReservedNameError) -> Self

Converts to this type from the input type.

impl From<SchemaError> for CedarSchemaError

fn from(source: SchemaError) -> Self

Converts to this type from the input type.

impl From<TcError<EntityUID>> for SchemaError

fn from(e: TcError<EntityUID>) -> Self

Converts to this type from the input type.

impl From<TypeNotDefinedError> for SchemaError

fn from(source: TypeNotDefinedError) -> Self

Converts to this type from the input type.

impl From<TypeShadowingError> for SchemaError

fn from(source: TypeShadowingError) -> Self

Converts to this type from the input type.

impl From<UndeclaredEntityTypesError> for SchemaError

fn from(source: UndeclaredEntityTypesError) -> Self

Converts to this type from the input type.

impl From<UnsupportedActionAttributeError> for SchemaError

fn from(source: UnsupportedActionAttributeError) -> Self

Converts to this type from the input type.

impl From<UnsupportedFeatureError> for SchemaError

fn from(source: UnsupportedFeatureError) -> Self

Converts to this type from the input type.