Struct Schema 

pub struct Schema {
    pub document: Document,
}

the schema itself

Fields

document: Document

the document this schema defines

this is redundant but it matches the schema document structure

Implementations

impl Schema

pub fn resolve_node_ref(&self, ref: &str) -> Option<&Node>

find the node matching the given ref

Panics

Panics if ref is not of the form [id="foo"].

pub fn resolve_prop_ref(&self, ref: &str) -> Option<&Prop>

find the prop matching the given ref

Panics

Panics if ref is not of the form [id="foo"].

pub fn resolve_value_ref(&self, ref: &str) -> Option<&Value>

find the value matching the given ref

Panics

Panics if ref is not of the form [id="foo"].

pub fn resolve_children_ref(&self, ref: &str) -> Option<&Children>

find the children matching the given ref

Panics

Panics if ref is not of the form [id="foo"].

impl Schema

pub fn parse(schema_kdl: &str) -> Result<Self, Error<impl ErrorSpan>>

parse a KDL schema definition

Errors

returns an error if knuffel can’t parse the document as a Schema

Trait Implementations

impl Debug for Schema

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

Formats the value using the given formatter.

impl<S> Decode<S> for Schema

where S: ErrorSpan,

fn decode_node( node: &SpannedNode<S>, ctx: &mut Context<S>, ) -> Result<Self, DecodeError<S>>

Decodes the node from the ast

impl<S> DecodeChildren<S> for Schema

where S: ErrorSpan,

fn decode_children( children: &[SpannedNode<S>], ctx: &mut Context<S>, ) -> Result<Self, DecodeError<S>>

Decodes from a list of chidren ASTs

impl Default for Schema

fn default() -> Schema

Returns the “default value” for a type.

impl PartialEq for Schema

fn eq(&self, other: &Schema) -> 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 Eq for Schema

impl StructuralPartialEq for Schema