Struct EnumOption 

#[non_exhaustive]
pub struct EnumOption {
    pub value: String,
    pub title: String,
    pub description: Option<String>,
    pub meta: Option<Meta>,
}

A titled enum option with a const value, human-readable title, and optional description.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

value: String

The constant value for this option.

title: String

Human-readable title for this option.

description: Option<String>

Human-readable description.

Optional. Omitted and null are equivalent and mean no description is provided.

meta: Option<Meta>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

Optional. Omitted and null are equivalent and mean no metadata.

See protocol docs: Extensibility

Implementations

impl EnumOption

pub fn new(value: impl Into<String>, title: impl Into<String>) -> Self

Create a new enum option.

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

Human-readable description.

pub fn meta(self, meta: impl IntoOption<Meta>) -> Self

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

Optional. Omitted and null are equivalent and mean no metadata.

See protocol docs: Extensibility

Trait Implementations

impl Clone for EnumOption

fn clone(&self) -> EnumOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnumOption

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EnumOption

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EnumOption

impl JsonSchema for EnumOption

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for EnumOption

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EnumOption

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 EnumOption