Enum Schema 

pub enum Schema {
    Scalar(ScalarKind),
    Enum(Vec<String>),
    List(Box<Schema>),
    Record(Vec<Field>),
}

The declared shape of a value. Mirrors lattice_config::ConfigSchema.

Examples

use lattice_plugin_sdk::shape::{ConfigShape, ScalarKind, Schema};

// The constructors are shorthands for the scalar / list forms.
assert_eq!(Schema::int(), Schema::Scalar(ScalarKind::Int));
assert_eq!(<Vec<String> as ConfigShape>::schema(), Schema::list(Schema::string()));

Variants

Scalar(ScalarKind)

A single leaf of the given kind.

Enum(Vec<String>)

A closed set of strings; a value must be a Value::Str spelling one of them. #[derive(ConfigShape)] on an all-unit enum produces this, variants kebab-cased in declaration order — and it is what lets :customize offer a picker instead of a text field.

List(Box<Schema>)

A homogeneous list whose every element has the inner shape.

Record(Vec<Field>)

A struct-like record: named fields, each with its own shape, doc and required flag. Field order is declaration order.

Implementations

impl Schema

pub fn string() -> Self

Schema::Scalar(ScalarKind::Str).

pub fn int() -> Self

Schema::Scalar(ScalarKind::Int).

pub fn bool() -> Self

Schema::Scalar(ScalarKind::Bool).

pub fn list(inner: Schema) -> Self

A list whose elements have shape inner (boxes it for you).

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.

impl Eq for Schema

impl PartialEq for Schema

fn eq(&self, other: &Schema) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Schema