Struct PromptArgument 

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

Argument for a prompt

Fields

name: String

Intended for programmatic or logical use

description: Option<String>

Description of the argument

required: Option<bool>

Whether this argument is required

title: Option<String>

Intended for UI and end-user contexts

Implementations

impl PromptArgument

pub fn new<S: Into<String>>(name: S) -> Self

Create a new prompt argument

pub fn with_title<S: Into<String>>(self, title: S) -> Self

Add title to the prompt argument

pub fn required(self, required: bool) -> Self

Mark as required

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PromptArgument

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

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 PromptArgument