Struct Field 

pub struct Field {
    pub name: String,
    pub schema: Schema,
    pub required: bool,
    pub aliases: Vec<String>,
    pub default: Option<Value>,
    pub description: Option<String>,
    pub stream_annotation: StreamAnnotation,
}

Field definition in an object schema.

Fields

name: String

Field name as it appears in the schema

schema: Schema

Expected type for this field

required: bool

Whether this field is required (true) or optional (false)

aliases: Vec<String>

Alternative names this field might have (aliases)

default: Option<Value>

Default value if field is missing (JSON string representation)

description: Option<String>

Description of the field (for documentation)

stream_annotation: StreamAnnotation

Streaming annotation (controls emission timing)

Implementations

impl Field

pub fn required(name: impl Into<String>, schema: Schema) -> Self

Create a new required field.

pub fn optional(name: impl Into<String>, schema: Schema) -> Self

Create a new optional field.

pub fn with_alias(self, alias: impl Into<String>) -> Self

Add an alias to this field.

pub fn with_default(self, default: Value) -> Self

Add a default value for this field.

pub fn with_description(self, description: impl Into<String>) -> Self

Add a description to this field.

pub fn with_stream_annotation(self, annotation: StreamAnnotation) -> Self

Set the streaming annotation for this field.

Examples

use simple_agents_healing::schema::{Field, Schema, StreamAnnotation};

// Don't emit until non-null
let id_field = Field::required("id", Schema::Int)
    .with_stream_annotation(StreamAnnotation::NotNull);

// Only emit when complete
let status_field = Field::required("status", Schema::String)
    .with_stream_annotation(StreamAnnotation::Done);

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Field

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Field

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

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 Field