Enum cedar_policy_core::entities::JsonDeserializationError

pub enum JsonDeserializationError {
    Serde(Error),
    ParseEscape {
        kind: EscapeKind,
        value: String,
        errs: ParseErrors,
    },
    RestrictedExpressionError(RestrictedExprError),
    ExpectedLiteralEntityRef {
        ctx: Box<JsonDeserializationErrorContext>,
        got: Box<Either<Value, Expr>>,
    },
    ExpectedExtnValue {
        ctx: Box<JsonDeserializationErrorContext>,
        got: Box<Either<Value, Expr>>,
    },
    ContextCreation(ContextCreationError),
    ActionParentIsNotAction {
        uid: EntityUID,
        parent: EntityUID,
    },
    MissingImpliedConstructor {
        ctx: Box<JsonDeserializationErrorContext>,
        return_type: Box<SchemaType>,
        arg_type: Box<SchemaType>,
    },
    DuplicateKeyInRecordLiteral {
        ctx: Box<JsonDeserializationErrorContext>,
        key: SmolStr,
    },
    EntityAttributeEvaluation(EntityAttrEvaluationError),
    EntitySchemaConformance(EntitySchemaConformanceError),
    UnexpectedRecordAttr {
        ctx: Box<JsonDeserializationErrorContext>,
        record_attr: SmolStr,
    },
    MissingRequiredRecordAttr {
        ctx: Box<JsonDeserializationErrorContext>,
        record_attr: SmolStr,
    },
    TypeMismatch {
        ctx: Box<JsonDeserializationErrorContext>,
        err: TypeMismatchError,
    },
    HeterogeneousSet {
        ctx: Box<JsonDeserializationErrorContext>,
        err: HeterogeneousSetError,
    },
    ExtensionFunctionLookup {
        ctx: Box<JsonDeserializationErrorContext>,
        err: ExtensionFunctionLookupError,
    },
    UnknownInImplicitConstructorArg {
        ctx: Box<JsonDeserializationErrorContext>,
        arg: Box<RestrictedExpr>,
    },
    ExprTag(Box<JsonDeserializationErrorContext>),
    Null(Box<JsonDeserializationErrorContext>),
}

Errors thrown during deserialization from JSON

Variants

Serde(Error)

Error thrown by the serde_json crate

ParseEscape

Contents of an escape failed to parse.

Fields

kind: EscapeKind

Escape kind

value: String

Escape value at fault

errs: ParseErrors

Parse errors

RestrictedExpressionError(RestrictedExprError)

Restricted expression error

ExpectedLiteralEntityRef

A field that needs to be a literal entity reference, was some other JSON value

Fields

ctx: Box<JsonDeserializationErrorContext>

Context of this error

got: Box<Either<Value, Expr>>

the expression we got instead

ExpectedExtnValue

A field that needs to be an extension value, was some other JSON value

Fields

ctx: Box<JsonDeserializationErrorContext>

Context of this error

got: Box<Either<Value, Expr>>

the expression we got instead

ContextCreation(ContextCreationError)

Errors creating the request context from JSON

ActionParentIsNotAction

Parents of actions should be actions, but this action has a non-action parent

Fields

uid: EntityUID

Action entity that had the invalid parent

parent: EntityUID

Parent that is invalid

MissingImpliedConstructor

Schema-based parsing needed an implicit extension constructor, but no suitable constructor was found

Fields

ctx: Box<JsonDeserializationErrorContext>

Context of this error

return_type: Box<SchemaType>

return type of the constructor we were looking for

arg_type: Box<SchemaType>

argument type of the constructor we were looking for

DuplicateKeyInRecordLiteral

The same key appears two or more times in a single record literal

Fields

ctx: Box<JsonDeserializationErrorContext>

Context of this error

key: SmolStr

The key that appeared two or more times

EntityAttributeEvaluation(EntityAttrEvaluationError)

Error when evaluating an entity attribute

EntitySchemaConformance(EntitySchemaConformanceError)

During schema-based parsing, encountered an entity which does not conform to the schema.

This error contains the Entity analogues some of the other errors listed below, among other things.

UnexpectedRecordAttr

During schema-based parsing, encountered this attribute on a record, but that attribute shouldn’t exist on that record

Fields

ctx: Box<JsonDeserializationErrorContext>

Context of this error

record_attr: SmolStr

Name of the (Record) attribute which was unexpected

MissingRequiredRecordAttr

During schema-based parsing, didn’t encounter this attribute of a record, but that attribute should have existed

Fields

ctx: Box<JsonDeserializationErrorContext>

Context of this error

record_attr: SmolStr

Name of the (Record) attribute which was expected

TypeMismatch

During schema-based parsing, found a different type than the schema indicated.

(This is used in all cases except inside entity attributes; type mismatches in entity attributes are reported as Self::EntitySchemaConformance. As of this writing, that means this should only be used for schema-based parsing of the Context.)

Fields

ctx: Box<JsonDeserializationErrorContext>

Context of this error, which will be something other than EntityAttribute. (Type mismatches in entity attributes are reported as Self::EntitySchemaConformance.)

err: TypeMismatchError

Underlying error

HeterogeneousSet

During schema-based parsing, found a set whose elements don’t all have the same type. This doesn’t match any possible schema.

(This is used in all cases except inside entity attributes; heterogeneous sets in entity attributes are reported as Self::EntitySchemaConformance. As of this writing, that means this should only be used for schema-based parsing of the Context. Note that for non-schema-based parsing, heterogeneous sets are not an error.)

Fields

ctx: Box<JsonDeserializationErrorContext>

Context of this error, which will be something other than EntityAttribute. (Heterogeneous sets in entity attributes are reported as Self::EntitySchemaConformance.)

err: HeterogeneousSetError

Underlying error

ExtensionFunctionLookup

During schema-based parsing, error looking up an extension function. This error can occur during schema-based parsing because that may require getting information about any extension functions referenced in the JSON.

(This is used in all cases except inside entity attributes; extension function lookup errors in entity attributes are reported as Self::EntitySchemaConformance. As of this writing, that means this should only be used for schema-based parsing of the Context.)

Fields

ctx: Box<JsonDeserializationErrorContext>

Context of this error, which will be something other than EntityAttribute. (Extension function lookup errors in entity attributes are reported as Self::EntitySchemaConformance.)

err: ExtensionFunctionLookupError

Underlying error

UnknownInImplicitConstructorArg

During schema-based parsing, found an unknown in an argument to an extension function being processed in implicit-constructor form. This is not currently supported. To pass an unknown to an extension function, use the explicit-constructor form.

Fields

ctx: Box<JsonDeserializationErrorContext>

Context of this error

arg: Box<RestrictedExpr>

Argument which contains an unknown

ExprTag(Box<JsonDeserializationErrorContext>)

Raised when a JsonValue contains the no longer supported __expr escape

Null(Box<JsonDeserializationErrorContext>)

Raised when the input JSON contains a null

Trait Implementations

impl Debug for JsonDeserializationError

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

Formats the value using the given formatter.

impl Diagnostic for JsonDeserializationError

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 JsonDeserializationError

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

Formats the value using the given formatter.

impl Error for JsonDeserializationError

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<ContextCreationError> for JsonDeserializationError

fn from(source: ContextCreationError) -> Self

Converts to this type from the input type.

impl From<EntityAttrEvaluationError> for JsonDeserializationError

fn from(source: EntityAttrEvaluationError) -> Self

Converts to this type from the input type.

impl From<Error> for JsonDeserializationError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<JsonDeserializationError> for ContextJsonDeserializationError

fn from(source: JsonDeserializationError) -> Self

Converts to this type from the input type.

impl From<JsonDeserializationError> for EntitiesError

fn from(source: JsonDeserializationError) -> Self

Converts to this type from the input type.

impl From<JsonDeserializationError> for FromJsonError

fn from(source: JsonDeserializationError) -> Self

Converts to this type from the input type.

impl From<RestrictedExprError> for JsonDeserializationError

fn from(source: RestrictedExprError) -> Self

Converts to this type from the input type.