Struct PromptArgument

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

Describes an argument that a prompt can accept.

JSON schema

{
 "description": "Describes an argument that a prompt can accept.",
 "type": "object",
 "required": [
   "name"
 ],
 "properties": {
   "description": {
     "description": "A human-readable description of the argument.",
     "type": "string"
   },
   "name": {
     "description": "The name of the argument.",
     "type": "string"
   },
   "required": {
     "description": "Whether this argument must be provided.",
     "type": "boolean"
   }
 }
}

Fields

description: Option<String>

A human-readable description of the argument.

name: String

The name of the argument.

required: Option<bool>

Whether this argument must be provided.

Trait Implementations

impl Clone for PromptArgument

fn clone(&self) -> PromptArgument

Returns a copy 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 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.