Struct cedar_policy::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 namespaces(&self) -> impl Iterator<Item = Option<EntityNamespace>> + '_

Extract namespaces defined in this SchemaFragment. Each namespace entry defines the name of the namespace and the entity types and actions that exist in the namespace.

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

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

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

Parse a SchemaFragment from a reader containing the natural schema syntax

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

Parse a SchemaFragment from a string containing the natural schema syntax

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

Create a SchemaFragment directly from a file.

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

Serialize this SchemaFragment as a json value

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

Serialize this SchemaFragment as a json value

pub fn as_natural(&self) -> Result<String, ToHumanSyntaxError>

Serialize this SchemaFragment into the natural syntax

Trait Implementations

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 valid JSON, or if the JSON structure does not form 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 = SchemaError

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.