Struct ValidatorSchema 

pub struct ValidatorSchema { /* private fields */ }

Implementations

impl ValidatorSchema

pub fn principals(&self) -> impl Iterator<Item = &EntityType>

Returns an iterator over every entity type that can be a principal for any action in this schema

pub fn resources(&self) -> impl Iterator<Item = &EntityType>

Returns an iterator over every entity type that can be a resource for any action in this schema

pub fn principals_for_action( &self, action: &EntityUID, ) -> Option<impl Iterator<Item = &EntityType>>

Returns an iterator over every entity type that can be a principal for action in this schema

Errors

Returns None if action is not found in the schema

pub fn resources_for_action( &self, action: &EntityUID, ) -> Option<impl Iterator<Item = &EntityType>>

Returns an iterator over every entity type that can be a resource for action in this schema

Errors

Returns None if action is not found in the schema

pub fn ancestors<'a>( &'a self, ty: &'a Name, ) -> Option<impl Iterator<Item = &'a Name> + 'a>

Returns an iterator over all the entity types that can be a parent of ty

Errors

Returns None if the ty is not found in the schema

pub fn action_groups(&self) -> impl Iterator<Item = &EntityUID>

Returns an iterator over all the action groups defined in this schema

pub fn actions(&self) -> impl Iterator<Item = &EntityUID>

Returns an iterator over all actions defined in this schema

pub fn empty() -> ValidatorSchema

Create a ValidatorSchema without any definitions (of entity types, common types, or actions).

pub fn from_json_value(json: Value, extensions: Extensions<'_>) -> Result<Self>

Construct a ValidatorSchema from a JSON value (which should be an object matching the SchemaFileFormat shape).

pub fn from_file(file: impl Read, extensions: Extensions<'_>) -> Result<Self>

Construct a ValidatorSchema directly from a file.

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

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

pub fn from_schema_file( schema_file: SchemaFragment, action_behavior: ActionBehavior, extensions: Extensions<'_>, ) -> Result<ValidatorSchema>

pub fn from_schema_fragments( fragments: impl IntoIterator<Item = ValidatorSchemaFragment>, ) -> Result<ValidatorSchema>

Construct a new ValidatorSchema from some number of schema fragments.

pub fn get_action_id(&self, action_id: &EntityUID) -> Option<&ValidatorActionId>

Lookup the ValidatorActionId object in the schema with the given name.

pub fn get_entity_type<'a>( &'a self, entity_type_id: &Name, ) -> Option<&'a ValidatorEntityType>

Lookup the ValidatorEntityType object in the schema with the given name.

pub fn entity_types( &self, ) -> impl Iterator<Item = (&Name, &ValidatorEntityType)>

An iterator matching the entity Types to their Validator Types

pub fn context_type(&self, action: &EntityUID) -> Option<Type>

Get the Type of context expected for the given action. This always reutrns a closed record type.

Returns None if the action is not in the schema.

pub fn action_entities(&self) -> Result<Entities, EntitiesError>

Construct an Entity object for each action in the schema

Trait Implementations

impl Clone for ValidatorSchema

fn clone(&self) -> ValidatorSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidatorSchema

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

Formats the value using the given formatter.

impl FromStr for ValidatorSchema

type Err = SchemaError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl RequestSchema for ValidatorSchema

type Error = RequestValidationError

Error type returned when a request fails validation

fn validate_request( &self, request: &Request, extensions: Extensions<'_>, ) -> Result<(), Self::Error>

Validate the given request, returning Err if it fails validation

impl Serialize for ValidatorSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<SchemaFragment> for ValidatorSchema

type Error = SchemaError

The type returned in the event of a conversion error.

fn try_from(frag: SchemaFragment) -> Result<ValidatorSchema>

Performs the conversion.