Struct StateFieldSpec 

pub struct StateFieldSpec {
    pub kind: Option<StateType>,
    pub description: String,
    pub default: Option<Value>,
}

One declared state key: its type, meaning, and optional starting value.

The state section is the session’s data dictionary. Declaring it is optional, but once present it powers editor autocomplete, key-existence warnings for every guard/effect/tool reference, typed key constants in generated code, and default seeding at connect.

Fields

kind: Option<StateType>

Declared JSON type.

description: String

What this key means.

default: Option<Value>

Initial value seeded at connect when the key is unset.

Trait Implementations

impl Clone for StateFieldSpec

fn clone(&self) -> StateFieldSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateFieldSpec

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

Formats the value using the given formatter.

impl Default for StateFieldSpec

fn default() -> StateFieldSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StateFieldSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for StateFieldSpec

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for StateFieldSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.