Struct ValidatorSchema 

pub struct ValidatorSchema { /* private fields */ }

Implementations

impl ValidatorSchema

pub fn empty() -> ValidatorSchema

pub fn from_json_value(json: Value) -> 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) -> Result<Self>

Construct a ValidatorSchema directly from a file.

pub fn from_schema_file( schema_file: SchemaFragment, action_behavior: ActionBehavior, ) -> 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( &self, entity_type_id: &Name, ) -> Option<&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 get_context_schema( &self, action: &EntityUID, ) -> Option<impl ContextSchema>

Since different Actions have different schemas for Context, you must specify the Action in order to get a ContextSchema.

Returns None if the action is not in the schema.

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

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 Schema for ValidatorSchema

fn attr_type(&self, entity_type: &EntityType, attr: &str) -> Option<SchemaType>

Do entities of the given type have the given attribute, and if so, what type?

fn required_attrs<'s>( &'s self, entity_type: &EntityType, ) -> Box<dyn Iterator<Item = SmolStr> + 's>

Get the names of all the required attributes for the given entity type.

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 TryInto<ValidatorSchema> for SchemaFragment

type Error = SchemaError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<ValidatorSchema>

Performs the conversion.