Struct FieldDef 

pub struct FieldDef {
    pub name: String,
    pub description: String,
    pub field_type: FieldType,
    pub kind: FieldKind,
    pub cacheable: bool,
    pub examples: Vec<Value>,
}

A top-level field definition within a Signature.

Fields

name: String

The field name.

description: String

A human-readable description of the field.

field_type: FieldType

The type of this field.

kind: FieldKind

Whether this is an input or output field.

cacheable: bool

Whether this input field’s value is stable across calls within a conversation and therefore eligible to sit inside the cacheable prefix of the user message. Default false (backwards-compatible): only fields a application explicitly declares stable are cached. The ChatAdapter places a cache breakpoint after the last cacheable input field; meaningless on output fields.

examples: Vec<Value>

Concrete example values for this field, sourced from the JSON Schema examples keyword on the originating schema. Rendered in the system prompt under the field’s description so the model sees “what good output looks like” without bloating the instructions string. Defaults to empty; the schema converter caps at the first three examples to bound prompt size.

Implementations

impl FieldDef

pub fn input( name: impl Into<String>, field_type: FieldType, description: impl Into<String>, ) -> Self

Create an input field definition.

field_type sits between the two String args by design: it’s the only non-string positional arg, so callers cannot silently transpose name and description without a compile error from the misplaced FieldType enum value.

pub fn output( name: impl Into<String>, field_type: FieldType, description: impl Into<String>, ) -> Self

Create an output field definition. See Self::input for the rationale behind the arg order (field_type between the two String args).

pub fn with_examples(self, examples: Vec<Value>) -> Self

Attach concrete example values to this field. Builder-style for test ergonomics — production paths populate Self::examples directly via the JSON Schema converter in schema.rs.

Trait Implementations

impl Clone for FieldDef

fn clone(&self) -> FieldDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FieldDef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FieldDef

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FieldDef

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FieldDef