Struct cedar_policy_core::entities::Entities

pub struct Entities { /* private fields */ }

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.

Implementations

impl Entities

pub fn new() -> Self

Create a fresh Entities with no entities

pub fn partial(self) -> Self

Transform the store into a partial store, where attempting to dereference a non-existent EntityUID results in a residual instead of an error.

pub fn entity(&self, uid: &EntityUID) -> Dereference<'_, Entity>

Get the Entity with the given UID, if any

pub fn iter(&self) -> impl Iterator<Item = &Entity>

Iterate over the Entitys in the Entities

pub fn from_entities( entities: impl IntoIterator<Item = Entity>, tc_computation: TCComputation ) -> Result<Self>

Create an Entities object with the given entities.

If you pass TCComputation::AssumeAlreadyComputed, then the caller is responsible for ensuring that TC and DAG hold before calling this method.

pub fn to_json_value(&self) -> Result<Value>

Convert an Entities object into a JSON value suitable for parsing in via EntityJsonParser.

The returned JSON value will be parse-able even with no Schema.

To parse an Entities object from a JSON value, use EntityJsonParser.

pub fn write_to_json(&self, f: impl Write) -> Result<()>

Dump an Entities object into an entities JSON file.

The resulting JSON will be suitable for parsing in via EntityJsonParser, and will be parse-able even with no Schema.

To read an Entities object from an entities JSON file, use EntityJsonParser.

Trait Implementations

impl Clone for Entities

fn clone(&self) -> Entities

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Entities

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

Formats the value using the given formatter.

impl Default for Entities

fn default() -> Entities

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Entities

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Entities

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

Formats the value using the given formatter.

impl IntoIterator for Entities

type Item = Entity

The type of the elements being iterated over.

type IntoIter = IntoValues<EntityUID, Entity>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Entities> for Entities

fn eq(&self, other: &Entities) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Entities

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Entities

impl StructuralEq for Entities

impl StructuralPartialEq for Entities