Struct SchemaBundle 

pub struct SchemaBundle {
    pub s2c: Value,
    pub common_types: Value,
    pub catalog: Value,
    pub custom_cuttable_keys: Option<Vec<String>>,
}

The three schema documents describing one surface contract.

Fields

s2c: Value

The server-to-client envelope schema.

common_types: Value

Shared type definitions the other two reference.

catalog: Value

The component and function catalog.

custom_cuttable_keys: Option<Vec<String>>

Keys whose string values may be closed early while streaming.

None uses DEFAULT_CUTTABLE_KEYS. Override it when a catalog puts long free text under a name the defaults do not cover.

Implementations

impl SchemaBundle

pub fn from_catalog(catalog: Value) -> Self

A bundle holding only a catalog document.

pub fn catalog_id(&self) -> Option<&str>

The catalogId this bundle’s catalog declares.

pub fn cuttable_keys(&self) -> Vec<String>

The keys whose string values may be closed early while streaming.

pub fn render_llm_instructions(&self) -> String

Renders the bundle as the schema block of a prompt.

The common-types section is dropped when it has nothing to say — no $defs, or an empty one — so the model is not handed an empty document to reason about.

pub fn prune( self, allowed_components: &[String], allowed_messages: &[String], ) -> Self

Restricts the bundle to a subset of components and message types.

Either list may be empty, meaning “keep everything of that kind”. After the restriction, unreferenced type definitions are dropped from both the envelope schema and the common types.

pub fn relaxed(self) -> Self

Drops additionalProperties: false everywhere in the catalog.

Structured-output APIs reject schemas that forbid extra properties in places they need them; explicit true is left alone because that is a deliberate statement rather than a default.

Trait Implementations

impl Clone for SchemaBundle

fn clone(&self) -> SchemaBundle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaBundle

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

Formats the value using the given formatter.

impl Default for SchemaBundle

fn default() -> SchemaBundle

Returns the “default value” for a type.

impl PartialEq for SchemaBundle

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