Struct EntityJsonParser

pub struct EntityJsonParser<'e, 's, S: Schema = NoEntitiesSchema> { /* private fields */ }

Struct used to parse entities from JSON.

Implementations

impl<'e, 's, S: Schema> EntityJsonParser<'e, 's, S>

pub fn new( schema: Option<&'s S>, extensions: &'e Extensions<'e>, tc_computation: TCComputation, ) -> Self

Create a new EntityJsonParser.

schema represents a source of Action entities, which will be added to the entities parsed from JSON. (If any Action entities are present in the JSON, and a schema is also provided, each Action entity in the JSON must exactly match its definition in the schema or an error is returned.)

If a schema is present, this will also inform the parsing: for instance, it will allow __entity and __extn escapes to be implicit.

Finally, if a schema is present, the EntityJsonParser will ensure that the produced entities fully conform to the schema – for instance, it will error if attributes have the wrong types (e.g., string instead of integer), or if required attributes are missing or superfluous attributes are provided.

If you pass TCComputation::AssumeAlreadyComputed, then the caller is responsible for ensuring that TC holds before calling this method.

pub fn from_json_str(&self, json: &str) -> Result<Entities, EntitiesError>

Parse an entities JSON file (in &str form) into an Entities object.

If the EntityJsonParser has a schema, this also adds Action entities declared in the schema.

pub fn from_json_value(&self, json: Value) -> Result<Entities, EntitiesError>

Parse an entities JSON file (in serde_json::Value form) into an Entities object.

If the EntityJsonParser has a schema, this also adds Action entities declared in the schema.

pub fn from_json_file(&self, json: impl Read) -> Result<Entities, EntitiesError>

Parse an entities JSON file (in std::io::Read form) into an Entities object.

If the EntityJsonParser has a schema, this also adds Action entities declared in the schema.

pub fn iter_from_json_str( &self, json: &str, ) -> Result<impl Iterator<Item = Entity> + '_, EntitiesError>

Parse an entities JSON file (in &str form) into an iterator over Entitys.

If the EntityJsonParser has a schema, this also adds Action entities declared in the schema.

pub fn iter_from_json_value( &self, json: Value, ) -> Result<impl Iterator<Item = Entity> + '_, EntitiesError>

Parse an entities JSON file (in serde_json::Value form) into an iterator over Entitys.

If the EntityJsonParser has a schema, this also adds Action entities declared in the schema.

pub fn iter_from_json_file( &self, json: impl Read, ) -> Result<impl Iterator<Item = Entity> + '_, EntitiesError>

Parse an entities JSON file (in std::io::Read form) into an iterator over Entitys.

If the EntityJsonParser has a schema, this also adds Action entities declared in the schema.

pub fn single_from_json_value( &self, value: Value, ) -> Result<Entity, EntitiesError>

Parse a single entity from an in-memory JSON value

pub fn single_from_json_str( &self, src: impl AsRef<str>, ) -> Result<Entity, EntitiesError>

Parse a single entity from a JSON string

pub fn single_from_json_file( &self, r: impl Read, ) -> Result<Entity, EntitiesError>

Parse a single entity from a JSON reader

Trait Implementations

impl<'e, 's, S: Clone + Schema> Clone for EntityJsonParser<'e, 's, S>

fn clone(&self) -> EntityJsonParser<'e, 's, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'e, 's, S: Debug + Schema> Debug for EntityJsonParser<'e, 's, S>

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

Formats the value using the given formatter.