Struct SchemaDocument 

pub struct SchemaDocument {
    pub nodes: Vec<SchemaNode>,
    pub root: SchemaNodeId,
    pub types: IndexMap<Identifier, SchemaNodeId>,
    pub exports: IndexSet<Identifier>,
    pub imports: IndexMap<Identifier, SchemaImport>,
    pub root_codegen: RootCodegen,
    pub codegen_defaults: CodegenDefaults,
}

Schema document with arena-based node storage

Fields

nodes: Vec<SchemaNode>

All schema nodes stored in a flat vector

root: SchemaNodeId

Root node reference

types: IndexMap<Identifier, SchemaNodeId>

Named type definitions declared by this document’s own $types.

exports: IndexSet<Identifier>

Names exposed to importers via $types.<alias>.<name>. Always a subset of types.keys(). When the source omits $export, this is identical to types.keys().

imports: IndexMap<Identifier, SchemaImport>

Imported schemas keyed by the alias declared in $import.

root_codegen: RootCodegen

Root-level codegen settings from $codegen.

codegen_defaults: CodegenDefaults

Root-level default codegen settings from $codegen-defaults.

Implementations

impl SchemaDocument

pub fn of<T: BuildSchema + 'static>() -> SchemaDocument

Generate a schema document for type T.

This is the main entry point for schema generation from Rust types.

Example

use eure_schema::SchemaDocument;

let schema = SchemaDocument::of::<MyType>();

impl SchemaDocument

pub fn new() -> Self

Create a new empty schema document

pub fn node(&self, id: SchemaNodeId) -> &SchemaNode

Get a reference to a node

pub fn node_mut(&mut self, id: SchemaNodeId) -> &mut SchemaNode

Get a mutable reference to a node

pub fn create_node(&mut self, content: SchemaNodeContent) -> SchemaNodeId

Create a new node and return its ID

pub fn register_type(&mut self, name: Identifier, node_id: SchemaNodeId)

Register a named type

pub fn get_type(&self, name: &Identifier) -> Option<SchemaNodeId>

Look up a named type

pub fn resolve_reference( &self, reference: &TypeReference, ) -> Option<SchemaNodeId>

Resolve a type reference to an arena node ID.

pub fn reference_name<'a>( &'a self, reference: &'a TypeReference, ) -> Option<TypeReferenceName<'a>>

Return the user-facing name for a type reference when it is nameable.

pub fn display_reference(&self, reference: &TypeReference) -> String

Best-effort display name for diagnostics.

Trait Implementations

impl Clone for SchemaDocument

fn clone(&self) -> SchemaDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaDocument

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

Formats the value using the given formatter.

impl Default for SchemaDocument

fn default() -> Self

Returns the “default value” for a type.

impl IntoEure for SchemaDocument

type Error = WriteError

The error type returned when writing.

fn write(value: Self, c: &mut DocumentConstructor) -> Result<(), Self::Error>

Write a value to the current node in the document constructor.

fn write_flatten( value: T, rec: &mut RecordWriter<'_>, ) -> Result<(), Self::Error>

Write a value as flattened record fields.

impl PartialEq for SchemaDocument

fn eq(&self, other: &SchemaDocument) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SchemaDocument