Struct SchemaDocument 

pub struct SchemaDocument {
    pub nodes: Vec<SchemaNode>,
    pub root: SchemaNodeId,
    pub types: IndexMap<Identifier, SchemaNodeId>,
}

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 ($types)

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

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 PartialEq for SchemaDocument

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SchemaDocument