Struct Schema 

pub struct Schema { /* private fields */ }

Schema for validating configuration

Implementations

impl Schema

pub fn from_json(json: &str) -> Result<Self>

Load a schema from a JSON string

pub fn from_yaml(yaml: &str) -> Result<Self>

Load a schema from a YAML string

pub fn from_file(path: impl AsRef<Path>) -> Result<Self>

Load a schema from a file (JSON or YAML based on extension)

pub fn validate(&self, value: &Value) -> Result<()>

Validate a Value against this schema

Returns Ok(()) if valid, or an error with details about the first validation failure.

pub fn validate_collect(&self, value: &Value) -> Vec<ValidationError>

Validate and collect all errors (instead of failing on first)

pub fn as_value(&self) -> &Value

Get the raw schema value

pub fn to_yaml(&self) -> Result<String>

Output schema as YAML

pub fn to_json(&self) -> Result<String>

Output schema as JSON

pub fn to_markdown(&self) -> String

Generate markdown documentation from the schema

pub fn to_template(&self) -> String

Generate a YAML template from the schema

Creates a configuration template with default values and comments indicating required fields and descriptions.

pub fn get_default(&self, path: &str) -> Option<Value>

Get the default value for a config path from the schema

Navigates the schema’s properties structure to find the default value for the given dot-separated path.

Example

let schema = Schema::from_yaml(r#"
type: object
properties:
  database:
    type: object
    properties:
      port:
        type: integer
        default: 5432
"#).unwrap();

assert_eq!(schema.get_default("database.port"), Some(holoconf_core::Value::Integer(5432)));
assert_eq!(schema.get_default("missing"), None);

pub fn allows_null(&self, path: &str) -> bool

Check if null is allowed for a config path in the schema

Returns true if:

• The schema allows type: "null" or type: ["string", "null"]
• The path doesn’t exist in the schema (permissive by default)

Example

let schema = Schema::from_yaml(r#"
type: object
properties:
  nullable_field:
    type: ["string", "null"]
  non_nullable:
    type: string
"#).unwrap();

assert!(schema.allows_null("nullable_field"));
assert!(!schema.allows_null("non_nullable"));
assert!(schema.allows_null("missing")); // permissive for undefined paths

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.