Struct CompiledSchemaLoader 

pub struct CompiledSchemaLoader { /* private fields */ }

Loader for compiled GraphQL schemas from JSON files.

Loads and caches a compiled schema from a JSON file on disk. Used during server startup to prepare the schema for query execution.

Implementations

impl CompiledSchemaLoader

pub fn new<P: AsRef<Path>>(path: P) -> Self

Create a new schema loader pointing to a schema file.

Arguments

• path - Path to the compiled schema JSON file

Example

// Requires: schema.compiled.json file on disk.
let loader = CompiledSchemaLoader::new("schema.compiled.json");
let schema = loader.load().await?;

pub async fn load(&self) -> Result<CompiledSchema, SchemaLoadError>

Load schema from file.

Reads the schema JSON file, parses it, and returns a CompiledSchema.

Errors

Returns SchemaLoadError::NotFound if the file does not exist. Returns SchemaLoadError::IoError if the file cannot be read. Returns SchemaLoadError::ParseError if the JSON is malformed. Returns SchemaLoadError::ValidationError if schema validation fails.

Example

// Requires: schema.compiled.json file on disk.
let loader = CompiledSchemaLoader::new("schema.compiled.json");
let schema = loader.load().await?;

pub async fn load_extended( &self, ) -> Result<ExtendedCompiledSchema, SchemaLoadError>

Load schema and all optional platform extension sections from file.

In addition to the core schema (types, queries, mutations, subscriptions), this method parses and validates the "storage", "functions", and "realtime" top-level keys if they are present. Unknown top-level keys are ignored for forward compatibility.

Errors

Returns SchemaLoadError::NotFound if the file does not exist. Returns SchemaLoadError::IoError if the file cannot be read. Returns SchemaLoadError::ParseError if the JSON is malformed. Returns SchemaLoadError::ValidationError if any of the following fail:

• A storage bucket name contains whitespace or is empty.
• A function trigger string does not match a recognised pattern.
• A realtime entity name does not appear in the schema’s type definitions.

pub fn path(&self) -> &Path

Get the path to the schema file.

Trait Implementations

impl Clone for CompiledSchemaLoader

fn clone(&self) -> CompiledSchemaLoader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompiledSchemaLoader

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

Formats the value using the given formatter.