Struct fuel_indexer_lib::graphql::parser::ParsedGraphQLSchema

pub struct ParsedGraphQLSchema { /* private fields */ }

A wrapper object used to encapsulate a lot of the boilerplate logic related to parsing schema, creating mappings of types, fields, objects, etc.

Ideally ParsedGraphQLSchema prevents from having to manually parse async_graphql_parser TypeDefinitions in order to get metadata on the types (e.g., Is a foreign key? is a virtual type? and so on).

Implementations

impl ParsedGraphQLSchema

pub fn new( namespace: &str, identifier: &str, schema: Option<&GraphQLSchema> ) -> ParsedResult<Self>

Create a new ParsedGraphQLSchema.

pub fn namespace(&self) -> &str

Namespace of the indexer.

pub fn identifier(&self) -> &str

Identifier of the indexer.

pub fn objects(&self) -> &HashMap<String, ObjectType>

Mapping of object names to objects.

pub fn field_type_mappings(&self) -> &HashMap<String, String>

Mapping of fully qualified field names to their field types.

pub fn field_type_optionality(&self) -> &HashMap<String, bool>

A mapping of fully qualified field names to their respective optionalities.

pub fn type_defs(&self) -> &HashMap<String, TypeDefinition>

All type definitions in the schema.

pub fn field_defs(&self) -> &HashMap<String, (FieldDefinition, String)>

Mapping of fully qualified field names to their FieldDefinition and TypeDefinition name.

pub fn foreign_key_mappings( &self ) -> &HashMap<String, HashMap<String, (String, String)>>

All unique names of foreign key types in the schema.

pub fn object_field_mappings( &self ) -> &HashMap<String, BTreeMap<String, String>>

All objects and their field names and types, indexed by object name.

pub fn join_table_meta(&self) -> &HashMap<String, Vec<JoinTableMeta>>

Metadata related to many-to-many relationships in the GraphQL schema.

pub fn object_ordered_fields(&self) -> &HashMap<String, Vec<OrderedField>>

pub fn scalar_type_for(&self, f: &FieldDefinition) -> String

Return the base scalar type for a given FieldDefinition.

pub fn get_union(&self, name: &str) -> Option<&TypeDefinition>

Return the TypeDefinition associated with a given union name.

pub fn storage_backed_typedefs(&self) -> Vec<(&String, &TypeDefinition)>

Return a list of all type definitions that will have a record or table in the database; functionally, this means any non-enum or internal type defintions.

pub fn is_possible_foreign_key(&self, name: &str) -> bool

Whether the given field type name is a possible foreign key.

pub fn is_virtual_typedef(&self, name: &str) -> bool

Whether the given field type name is a type from which tables are not created.

pub fn is_enum_typedef(&self, name: &str) -> bool

Whether the given field type name is an enum type.

pub fn is_list_field_type(&self, name: &str) -> bool

Whether the given field type name is a list type.

pub fn is_list_typedef(&self, name: &str) -> bool

Whether a given TypeDefinition contains a field that is a list type.

pub fn is_union_typedef(&self, name: &str) -> bool

Whether the given field type name is a union type.

pub fn is_internal_typedef(&self, name: &str) -> bool

pub fn graphql_type(&self, cond: Option<&String>, name: &str) -> Option<&String>

Return the GraphQL type for a given FieldDefinition or TypeDefinition name.

This serves as a convenience function so that the caller doesn’t have to worry about handling the case in which cond is not present; for example, cond is None when retrieving the type for a top-level entity in a query.

pub fn has_type(&self, name: &str) -> bool

Ensure the given type is included in this Schema’s types

pub fn fully_qualified_namespace(&self) -> String

Fully qualified namespace for the indexer.

pub fn version(&self) -> &str

Version of the schema.

Trait Implementations

impl Clone for ParsedGraphQLSchema

fn clone(&self) -> ParsedGraphQLSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParsedGraphQLSchema

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

Formats the value using the given formatter.

impl Default for ParsedGraphQLSchema

fn default() -> Self

Returns the “default value” for a type.