Module cedar_policy_core::entities

This module contains the Entities type and related functionality.

Structs

• AllEntitiesNoAttrsSchema
  Simple type that implements Schema by allowing entities of all types to exist, and allowing all actions to exist, but expecting no attributes or parents on any entity (action or otherwise).
• AttributeType
  Attribute type structure used in SchemaType
• ContextJsonParser
  Struct used to parse context from JSON.
• Entities
  Represents an entity hierarchy, and allows looking up Entity objects by UID. Note that Entities is Serialize, but currently this is only used for the FFI layer in DRT. All others use (and should use) the from_json_*() and write_to_json() methods as necessary.
• EntityJson
  Serde JSON format for a single entity
• EntityJsonParser
  Struct used to parse entities from JSON.
• EntitySchemaConformanceChecker
  Struct used to check whether entities conform to a schema
• FnAndArg
  Structure expected by the __extn escape
• HeterogeneousSetError
  Found a set whose elements don’t all have the same type. This doesn’t match any possible schema.
• JsonRecord
  Structure representing a Cedar record in JSON
• NoEntitiesSchema
  Simple type that implements Schema by expecting no entities to exist at all
• NullContextSchema
  Simple type that implements ContextSchema by expecting an empty context
• NullEntityTypeDescription
  Simple type that implements EntityTypeDescription by expecting no attributes to exist
• TypeAndId
  Structure expected by the __entity escape
• TypeMismatchError
  Type mismatch error (in terms of SchemaType)
• 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.
• ValueParser
  Struct used to parse Cedar values from JSON.

Enums

• CedarValueJson
  The canonical JSON representation of a Cedar value. Many Cedar values have a natural one-to-one mapping to and from JSON values. Cedar values of some types, like entity references or extension values, cannot easily be represented in JSON and thus are represented using the __entity, or __extn escapes.
• ContextJsonDeserializationError
  Errors possible when deserializing request context from JSON
• Dereference
  Results from dereferencing values from the Entity Store
• EntitiesError
  Error type for errors raised in entities.rs.
• EntitySchemaConformanceError
  Errors raised when entities do not conform to the schema
• EntityUidJson
  Serde JSON format for Cedar values where we know we’re expecting an entity reference
• EscapeKind
  Escape kind
• ExtnValueJson
  Serde JSON format for Cedar values where we know we’re expecting an extension value
• GetSchemaTypeError
  Errors encountered when trying to compute the SchemaType of something
• JsonDeserializationError
  Errors thrown during deserialization from JSON
• JsonDeserializationErrorContext
  Gives information about the context of a JSON deserialization error (e.g., where we were in the JSON document).
• JsonSerializationError
  Errors thrown during serialization to JSON
• SchemaType
  Possible types that schema-based parsing can expect for Cedar values.
• TCComputation
  Describes the option for how the TC (transitive closure) of the entity hierarchy is computed
• TypecheckError
  Errors returned by typecheck_value_against_schematype() and typecheck_restricted_expr_against_schematype()

Traits

• ContextSchema
  Trait for schemas that can inform the parsing of Context data
• EntityTypeDescription
  Trait for a schema’s description of an individual entity type
• Schema
  Trait for Schemas that can inform the parsing of Entity JSON data

Functions

• schematype_of_lit
  Get the SchemaType of a Literal.
• schematype_of_partialvalue
  Get the SchemaType of a PartialValue.
• schematype_of_restricted_expr
  Get the SchemaType of a restricted expression.
• schematype_of_value
  Get the SchemaType of a Value.
• schematype_of_valuekind
  Get the SchemaType of a ValueKind.
• typecheck_restricted_expr_against_schematype
  Check whether the given RestrictedExpr typechecks with the given SchemaType. If the typecheck passes, return Ok(()). If the typecheck fails, return an appropriate Err.
• typecheck_value_against_schematype
  Check whether the given PartialValue typechecks with the given SchemaType. If the typecheck passes, return Ok(()). If the typecheck fails, return an appropriate Err.

Type Aliases

• Result
  Type alias for convenience