Struct PromptArgument 

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

Represents a prompt argument that can be passed to customize the prompt

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.

name: String

The name of the argument

title: Option<String>

A human-readable title for the argument

description: Option<String>

A description of what the argument is used for

required: Option<bool>

Whether this argument is required

Implementations

impl PromptArgument

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

Create a new prompt argument

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

Set the title

pub fn with_description<D: Into<String>>(self, description: D) -> Self

Set the description

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

Set the required flag

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 Default for PromptArgument

fn default() -> PromptArgument

Returns the “default value” for a type.

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 JsonSchema for PromptArgument

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 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