Struct ComponentDef 

pub struct ComponentDef {
    pub name: String,
    pub description: Option<String>,
    pub props: BTreeMap<String, PropDef>,
    pub required: Vec<String>,
    pub allowed_parents: Option<Vec<String>>,
    pub allowed_children: Option<Vec<String>>,
    /* private fields */
}

One component type in a catalog.

Fields

name: String

Type name, e.g. Text.

description: Option<String>

Human-readable description, carried into generated prompts.

props: BTreeMap<String, PropDef>

Properties, keyed by name.

required: Vec<String>

Property names that must be present, in declaration order.

allowed_parents: Option<Vec<String>>

Parent component types this may sit under. None means unrestricted.

SURFACE_COMPONENT stands for the implicit surface container, so ["Surface"] restricts a component to being the tree root.

allowed_children: Option<Vec<String>>

Child component types this may contain. None means unrestricted.

Implementations

impl ComponentDef

pub fn props_in_order(&self) -> impl Iterator<Item = &PropDef>

Properties in declaration order.

pub fn references(&self, component: &Component) -> Vec<ComponentRef>

Every component id a concrete component of this type references.

Locators are relative to the component object, e.g. child, children[2], children.componentId, tabs[0].child.

Trait Implementations

impl Clone for ComponentDef

fn clone(&self) -> ComponentDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentDef

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

Formats the value using the given formatter.

impl Eq for ComponentDef

impl PartialEq for ComponentDef

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ComponentDef