Struct Catalog 

pub struct Catalog {
    pub catalog_id: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub instructions: Option<String>,
    pub components: BTreeMap<String, ComponentDef>,
    pub functions: BTreeMap<String, FunctionDef>,
    /* private fields */
}

A set of component and function definitions, identified by catalogId.

Fields

catalog_id: String

Opaque identifier agent and renderer negotiate on.

title: Option<String>

Human-readable title.

description: Option<String>

Human-readable description.

instructions: Option<String>

Markdown design guidance specific to this catalog, for prompts.

components: BTreeMap<String, ComponentDef>

Component types, keyed by name.

functions: BTreeMap<String, FunctionDef>

Functions, keyed by name.

Implementations

impl Catalog

pub fn empty(catalog_id: impl Into<String>) -> Self

An empty catalog with the given id.

pub fn component(&self, name: &str) -> Option<&ComponentDef>

Looks up a component type.

pub fn has_component(&self, name: &str) -> bool

Whether this catalog defines the given component type.

pub fn components_in_order(&self) -> impl Iterator<Item = &ComponentDef>

Component types in declaration order.

pub fn insert_component(&mut self, def: ComponentDef)

Adds or replaces a component type.

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

Every component id referenced by component, using this catalog’s structural property definitions.

Returns an empty list for an unknown component type: without a definition there is no way to tell a child reference from a label.

pub fn basic() -> Self

The standard 18-component basic catalog.

pub fn from_schema(schema: &Value) -> Result<Self>

Parses an A2UI catalog JSON Schema document.

Understands the shape the specification uses: a top-level components map whose values are JSON Schemas, each typically an allOf of shared fragments plus a final object holding properties and required. The allOf members are merged; $refs to ComponentId and ChildList are what mark a property structural.

Errors

Returns Error::Catalog if the document is not an object or has no catalogId.

pub fn composition_violations( &self, components: &[Component], ) -> Vec<CompositionViolation>

Checks allowedParents / allowedChildren across a component tree.

Kept separate from crate::validate on purpose: the specification assigns composition failures their own renderer-side error codes (UNALLOWED_PARENT, UNALLOWED_CHILD), distinct from the structural validation codes. Components with no declared constraints never produce violations, which is every component of the basic catalog.

The root component’s parent is the implicit Surface container.

pub fn render_summary(&self) -> String

Renders the catalog as a compact summary for a generating model.

One line per component with its required and optional properties, plus the function list. This is the cheap alternative to pasting the whole JSON Schema; when a model needs the exact document instead, use SchemaBundle::render_llm_instructions.

Trait Implementations

impl Clone for Catalog

fn clone(&self) -> Catalog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Catalog

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

Formats the value using the given formatter.

impl Eq for Catalog

impl PartialEq for Catalog

fn eq(&self, other: &Catalog) -> 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 Catalog