Struct SchemaField 

pub struct SchemaField { /* private fields */ }

A single field declaration inside a @schema block.

Fields declared with SchemaField::optional are emitted with a * suffix, meaning the key does not have to be present in the data map, but its value is still type-checked when it is present.

Example

use aam_core::builder::SchemaField;

let f = SchemaField::required("host", "string");
assert_eq!(f.to_aaml(), "host: string");

let g = SchemaField::optional("debug", "bool");
assert_eq!(g.to_aaml(), "debug*: bool");

Implementations

impl SchemaField

pub fn required(name: impl Into<String>, type_name: impl Into<String>) -> Self

Creates a required field (rendered as name: type).

pub fn optional(name: impl Into<String>, type_name: impl Into<String>) -> Self

Creates an optional field (rendered as name*: type).

pub fn to_aaml_writer(&self, w: impl Write) -> Result

pub fn to_aaml(&self) -> String

Renders the field as an AAML field declaration string.

Trait Implementations

impl Clone for SchemaField

fn clone(&self) -> SchemaField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaField

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

Formats the value using the given formatter.