Struct SchemaFragment

pub struct SchemaFragment { /* private fields */ }

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

Implementations

impl SchemaFragment

pub fn namespace_annotations( &self, namespace: EntityNamespace, ) -> Option<impl Iterator<Item = (&str, &str)>>

Get annotations of a non-empty namespace.

We do not allow namespace-level annotations on the empty namespace.

Returns None if namespace is not found in the SchemaFragment

pub fn namespace_annotation( &self, namespace: EntityNamespace, annotation_key: impl AsRef<str>, ) -> Option<&str>

Get annotation value of a non-empty namespace by annotation key annotation_key

We do not allow namespace-level annotations on the empty namespace.

Returns None if namespace is not found in the SchemaFragment or annotation_key is not a valid annotation key or it does not exist

pub fn common_type_annotations( &self, namespace: Option<EntityNamespace>, ty: &str, ) -> Option<impl Iterator<Item = (&str, &str)>>

Get annotations of a common type declaration

Returns None if namespace is not found in the SchemaFragment or ty is not a valid common type ID or ty is not found in the corresponding namespace definition

pub fn common_type_annotation( &self, namespace: Option<EntityNamespace>, ty: &str, annotation_key: impl AsRef<str>, ) -> Option<&str>

Get annotation value of a common type declaration by annotation key annotation_key

Returns None if namespace is not found in the SchemaFragment or ty is not a valid common type ID or ty is not found in the corresponding namespace definition or annotation_key is not a valid annotation key or it does not exist

pub fn entity_type_annotations( &self, namespace: Option<EntityNamespace>, ty: &str, ) -> Option<impl Iterator<Item = (&str, &str)>>

Get annotations of an entity type declaration

Returns None if namespace is not found in the SchemaFragment or ty is not a valid entity type name or ty is not found in the corresponding namespace definition

pub fn entity_type_annotation( &self, namespace: Option<EntityNamespace>, ty: &str, annotation_key: impl AsRef<str>, ) -> Option<&str>

Get annotation value of an entity type declaration by annotation key annotation_key

Returns None if namespace is not found in the SchemaFragment or ty is not a valid entity type name or ty is not found in the corresponding namespace definition or annotation_key is not a valid annotation key or it does not exist

pub fn action_annotations( &self, namespace: Option<EntityNamespace>, id: &EntityId, ) -> Option<impl Iterator<Item = (&str, &str)>>

Get annotations of an action declaration

Returns None if namespace is not found in the SchemaFragment or id is not found in the corresponding namespace definition

pub fn action_annotation( &self, namespace: Option<EntityNamespace>, id: &EntityId, annotation_key: impl AsRef<str>, ) -> Option<&str>

Get annotation value of an action declaration by annotation key annotation_key

Returns None if namespace is not found in the SchemaFragment or id is not found in the corresponding namespace definition or annotation_key is not a valid annotation key or it does not exist

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

Extract namespaces defined in this SchemaFragment.

None indicates the empty namespace.

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

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

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

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

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

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

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

Serialize this SchemaFragment as a JSON value

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

Serialize this SchemaFragment as a JSON string

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

Serialize this SchemaFragment into a string in the Cedar schema syntax

Trait Implementations

impl Clone for SchemaFragment

fn clone(&self) -> SchemaFragment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaFragment

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

Formats the value using the given formatter.

impl FromStr for SchemaFragment

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.

type Err = CedarSchemaError

The associated error which can be returned from parsing.

impl TryInto<Schema> for SchemaFragment

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.

type Error = SchemaError

The type returned in the event of a conversion error.