Expand description
Shared syn-based parser for valence_schema! and valence_trait_schema!.
Used by:
valence-macros— proc-macro expansionvalence-codegen— build-time model generation from schema files
This crate depends only on syn / quote / proc-macro2 (no valence-core or public crate).
§Examples
Parse macro tokens:
use valence_schema_dsl::{parse_schema, SchemaSpec};
let tokens: proc_macro2::TokenStream = syn::parse_str(
r#"
Counter {
table: "counter",
version: "0.1.0",
fields: [
id: { r#type: FieldType::String, primary_key: true, required: true },
],
}
"#,
)
.expect("tokens");
let parsed = parse_schema(tokens).expect("parse");
assert_eq!(parsed.table_name, "counter");
let _ = std::any::type_name::<SchemaSpec>();Parse a host schema file:
use valence_schema_dsl::parse_schema_file;
let src = r#"
valence_schema! {
Widget {
table: "widget",
version: "0.1.0",
fields: [
id: { r#type: FieldType::String, primary_key: true, required: true },
],
}
}
"#;
let parsed = parse_schema_file(src).expect("parse");
assert_eq!(parsed.table_name, "widget");Re-exports§
pub use parse::*;
Modules§
- parse
- Parsed AST for the
valence_schema!DSL.
Structs§
- Extracted
Field Type - Result of lowering a
r#type: FieldType::…expression. - File
Parse Error - Error locating or parsing a schema/trait macro in a source file.
- Parsed
Trait Schema - Lowered trait DSL consumed by macros and codegen.
- Trait
Schema Spec - Top-level
TraitName { fields: ..., connections: ..., policies: ... }input.
Enums§
Functions§
- extract_
default_ string - Strip surrounding quotes for string literal defaults; otherwise return the raw token text.
- extract_
field_ type - Lower a field type expression, including optional Record
.target(…)model path. - extract_
field_ type_ string - Lower a
r#type: FieldType::…expression to Valence’s internal type name. - extract_
validator_ string - Lower
Validator::…tokens to validation DSL strings (email,min_length:5, …). - parse_
schema - Parse
valence_schema!body tokens into aParsedSchema. - parse_
schema_ file - Parse a schema file containing exactly one
valence_schema!invocation. - parse_
trait_ file - Parse a trait file containing exactly one
valence_trait_schema!invocation. - parse_
trait_ schema - Parse
valence_trait_schema!body tokens into aParsedTraitSchema.