Struct cedar_policy_core::entities::Entities

source ·
pub struct Entities { /* private fields */ }
Expand description

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§

source§

impl Entities

source

pub fn new() -> Self

Create a fresh Entities with no entities

source

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

Get the Entity with the given UID, if any

source

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

Iterate over the Entitys in the Entities

source

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.

source

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.

source

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.

source

pub fn to_dot_str(&self) -> Result<String, Error>

Write entities into a DOT graph

Trait Implementations§

source§

impl Clone for Entities

source§

fn clone(&self) -> Entities

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Entities

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Entities

source§

fn default() -> Entities

Returns the “default value” for a type. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for Entities

source§

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

Formats the value using the given formatter. Read more
source§

impl IntoIterator for Entities

source§

type Item = Entity

The type of the elements being iterated over.
source§

type IntoIter = IntoValues<EntityUID, Entity>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl PartialEq for Entities

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for Entities

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for Entities

source§

impl StructuralPartialEq for Entities

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToSmolStr for T
where T: Display + ?Sized,

source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,