Struct parser_database::ParserDatabase

pub struct ParserDatabase { /* private fields */ }

ParserDatabase is a container for a Schema AST, together with information gathered during schema validation. Each validation step enriches the database with information that can be used to work with the schema, without changing the AST. Instantiating with ParserDatabase::new() will perform a number of validations and make sure the schema makes sense, but it cannot fail. In case the schema is invalid, diagnostics will be created and the resolved information will be incomplete.

Validations are carried out in the following order:

• The AST is walked a first time to resolve names: to each relevant identifier, we attach an ID that can be used to reference the corresponding item (model, enum, field, …)
• The AST is walked a second time to resolve types. For each field and each type alias, we look at the type identifier and resolve what it refers to.
• The AST is walked a third time to validate attributes on models and fields.
• Global validations are then performed on the mostly validated schema. Currently only index name collisions.

Implementations

impl ParserDatabase

pub fn find_enum<'db>(&'db self, name: &str) -> Option<EnumWalker<'db>>

Find an enum by name.

pub fn find_model<'db>(&'db self, name: &str) -> Option<ModelWalker<'db>>

Find a model by name.

pub fn walk<I>(&self, id: I) -> Walker<'_, I>

Traverse a schema element by id.

pub fn walk_enums(&self) -> impl Iterator<Item = EnumWalker<'_>>

Walk all enums in the schema.

pub fn walk_models(&self) -> impl Iterator<Item = ModelWalker<'_>> + '_

Walk all the models in the schema.

pub fn walk_views(&self) -> impl Iterator<Item = ModelWalker<'_>> + '_

Walk all the views in the schema.

pub fn walk_composite_types( &self ) -> impl Iterator<Item = CompositeTypeWalker<'_>> + '_

Walk all the composite types in the schema.

pub fn walk_scalar_field_defaults_with_unknown_function( &self ) -> impl Iterator<Item = DefaultValueWalker<'_>>

Walk all scalar field defaults with a function not part of the common ones.

pub fn walk_relations( &self ) -> impl ExactSizeIterator<Item = RelationWalker<'_>> + Clone + '_

Walk all the relations in the schema. A relation may be defined by one or two fields; in both cases, it is still a single relation.

pub fn walk_complete_inline_relations( &self ) -> impl Iterator<Item = CompleteInlineRelationWalker<'_>> + '_

Iterate all complete relations that are not many to many and are correctly defined from both sides.

impl ParserDatabase

pub fn new(file: SourceFile, diagnostics: &mut Diagnostics) -> Self

See the docs on ParserDatabase.

pub fn ast(&self) -> &SchemaAst

The parsed AST.

pub fn enums_count(&self) -> usize

The total number of enums in the schema. This is O(1).

pub fn models_count(&self) -> usize

The total number of models in the schema. This is O(1).

pub fn source(&self) -> &str

The source file contents.

Trait Implementations

impl Debug for ParserDatabase

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

Formats the value using the given formatter.