Struct Schema 

pub struct Schema {
    pub version: SchemaVersion,
    pub types: BTreeMap<String, Vec<FieldDef>>,
}

Schema definition with versioning.

Represents a complete schema for a type, including version information and field definitions.

Examples

use hedl_core::schema_version::{Schema, SchemaVersion, FieldDef};

let mut schema = Schema::new(SchemaVersion::new(1, 0, 0));
schema.add_type("User", vec![
    FieldDef::required("id"),
    FieldDef::required("name"),
    FieldDef::optional("email"),
]);

Fields

version: SchemaVersion

Schema version.

types: BTreeMap<String, Vec<FieldDef>>

Type definitions: type name -> field definitions.

Implementations

impl Schema

pub fn new(version: SchemaVersion) -> Self

Create a new schema with the specified version.

Arguments

• version - The schema version

Examples

use hedl_core::schema_version::{Schema, SchemaVersion};

let schema = Schema::new(SchemaVersion::new(1, 0, 0));
assert_eq!(schema.version, SchemaVersion::new(1, 0, 0));
assert!(schema.types.is_empty());

pub fn add_type(&mut self, name: &str, fields: Vec<FieldDef>)

Add a type definition to the schema.

Arguments

• name - The type name
• fields - Field definitions for the type

Examples

use hedl_core::schema_version::{Schema, SchemaVersion, FieldDef};

let mut schema = Schema::new(SchemaVersion::new(1, 0, 0));
schema.add_type("User", vec![
    FieldDef::required("id"),
    FieldDef::required("name"),
]);
assert!(schema.types.contains_key("User"));

pub fn get_fields(&self, type_name: &str) -> Option<&Vec<FieldDef>>

Get field definitions for a type.

Arguments

• type_name - The type name to look up

Returns

Some(&Vec<FieldDef>) if the type exists, None otherwise

Examples

use hedl_core::schema_version::{Schema, SchemaVersion, FieldDef};

let mut schema = Schema::new(SchemaVersion::new(1, 0, 0));
schema.add_type("User", vec![FieldDef::required("id")]);

assert!(schema.get_fields("User").is_some());
assert!(schema.get_fields("Post").is_none());

pub fn is_compatible_with(&self, other: &Self) -> bool

Check if this schema is compatible with another schema.

Schemas are compatible if their versions are compatible.

Arguments

• other - The schema to check compatibility with

Returns

true if this schema can read data written for other

Examples

use hedl_core::schema_version::{Schema, SchemaVersion};

let v1 = Schema::new(SchemaVersion::new(1, 0, 0));
let v1_1 = Schema::new(SchemaVersion::new(1, 1, 0));
let v2 = Schema::new(SchemaVersion::new(2, 0, 0));

assert!(v1_1.is_compatible_with(&v1));
assert!(!v1.is_compatible_with(&v1_1));
assert!(!v2.is_compatible_with(&v1));

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.