cedar_policy

Struct SchemaFragment

source
pub struct SchemaFragment { /* private fields */ }
Expand description

Contains all the type information used to construct a Schema that can be used to validate a policy.

Implementations§

source§

impl SchemaFragment

source

pub fn namespaces(&self) -> impl Iterator<Item = Option<EntityNamespace>> + '_

Extract namespaces defined in this SchemaFragment.

None indicates the empty namespace.

source

pub fn from_json_str(src: &str) -> Result<Self, SchemaError>

Create a SchemaFragment from a string containing JSON in the JSON schema format.

source

pub fn from_json_value(json: Value) -> Result<Self, SchemaError>

Create a SchemaFragment from a JSON value (which should be an object of the shape required for the JSON schema format).

source

pub fn from_cedarschema_file( r: impl Read, ) -> Result<(Self, impl Iterator<Item = SchemaWarning>), CedarSchemaError>

Parse a SchemaFragment from a reader containing the Cedar schema syntax

source

pub fn from_cedarschema_str( src: &str, ) -> Result<(Self, impl Iterator<Item = SchemaWarning>), CedarSchemaError>

Parse a SchemaFragment from a string containing the Cedar schema syntax

source

pub fn from_json_file(file: impl Read) -> Result<Self, SchemaError>

Create a SchemaFragment directly from a JSON file (which should contain an object of the shape required for the JSON schema format).

source

pub fn to_json_value(self) -> Result<Value, SchemaError>

Serialize this SchemaFragment as a JSON value

source

pub fn to_json_string(&self) -> Result<String, SchemaError>

Serialize this SchemaFragment as a JSON string

source

pub fn to_cedarschema(&self) -> Result<String, ToCedarSchemaError>

Serialize this SchemaFragment into a string in the Cedar schema syntax

Trait Implementations§

source§

impl Debug for SchemaFragment

source§

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

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

impl FromStr for SchemaFragment

source§

fn from_str(src: &str) -> Result<Self, Self::Err>

Construct SchemaFragment from a string containing a schema formatted in the Cedar schema format. This can fail if the string is not a valid schema. This function does not check for consistency in the schema (e.g., references to undefined entities) because this is not required until a Schema is constructed.

source§

type Err = CedarSchemaError

The associated error which can be returned from parsing.
source§

impl TryInto<Schema> for SchemaFragment

source§

fn try_into(self) -> Result<Schema, Self::Error>

Convert SchemaFragment into a Schema. To build the Schema we need to have all entity types defined, so an error will be returned if any undeclared entity types are referenced in the schema fragment.

source§

type Error = SchemaError

The type returned in the event of a conversion error.

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> 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, 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.