Struct PromptArgument 

pub struct PromptArgument {
    pub description: Option<String>,
    pub name: String,
    pub required: Option<bool>,
    pub title: Option<String>,
}

Describes an argument that a prompt can accept.

Fields

description: Option<String>

A human-readable description of the argument.

name: String

Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn’t present).

required: Option<bool>

Whether this argument must be provided.

title: Option<String>

Intended for UI and end-user contexts — optimized to be human-readable and easily understood, even by those unfamiliar with domain-specific terminology.

If not provided, the name should be used for display (except for Tool, where annotations.title should be given precedence over using name, if present).

Implementations

impl PromptArgument

pub fn new(name: String) -> PromptArgument

Creates a value from its required fields; optional fields are None.

Trait Implementations

impl Clone for PromptArgument

fn clone(&self) -> PromptArgument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptArgument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PromptArgument

fn deserialize<__D>( __deserializer: __D, ) -> Result<PromptArgument, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PromptArgument

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PromptArgument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PromptArgument