Module cedar_policy_core::entities

source ·
Expand description

This module contains the Entities type and related functionality.

Structs

  • 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 and Deserialize, but currently this is only used for the Dafny-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.
  • FnAndArg
    Structure expected by the __extn escape
  • NullContextSchema
    Simple type that implements ContextSchema by expecting an empty context
  • NullSchema
    Simple type that implements Schema by expecting no attributes to exist
  • TypeAndId
    Structure expected by the __entity escape
  • ValueParser
    Struct used to parse Cedar values from JSON.

Enums

  • Dereference
    Results from dereferencing values from the Entity Store
  • EntitiesError
    Error type for errors raised in entities.rs.
  • EntityUidJSON
    Serde JSON format for Cedar values where we know we’re expecting an entity reference
  • ExtnValueJSON
    Serde JSON format for Cedar values where we know we’re expecting an extension value
  • JSONValue
    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 __expr, __entity, or __extn escapes.
  • 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

Traits

  • ContextSchema
    Trait for schemas that can inform the parsing of Context data
  • Schema
    Trait for Schemas that can inform the parsing of Entity JSON data

Type Definitions

  • Result
    Type alias for convenience