Struct PromptVariable 

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

A template variable definition.

Fields

name: String

Variable name (without braces).

description: Option<String>

Human-readable description for elicitation.

default: Option<String>

Default value if not provided.

required: bool

Whether the variable is required.

Implementations

impl PromptVariable

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

Creates a new required variable.

pub fn optional(name: impl Into<String>, default: impl Into<String>) -> Self

Creates a new optional variable with a default value.

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

Sets the description.

Trait Implementations

impl Clone for PromptVariable

fn clone(&self) -> PromptVariable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptVariable

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

Formats the value using the given formatter.

impl Default for PromptVariable

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PromptVariable

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PromptVariable> for TemplateVariable

fn from(prompt_var: PromptVariable) -> Self

Converts to this type from the input type.

impl From<TemplateVariable> for PromptVariable

fn from(template_var: TemplateVariable) -> Self

Converts to this type from the input type.

impl PartialEq for PromptVariable

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PromptVariable

impl StructuralPartialEq for PromptVariable