Struct TemplateParameter 

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

A parameter that callers must or may supply when instantiating a template.

Fields

name: String

Parameter name (used as {name} placeholder in step config values).

description: String

Human-readable description shown to the caller.

default_value: Option<String>

Optional default value used when the caller does not supply a value.

required: bool

Whether the caller must supply this parameter.

Implementations

impl TemplateParameter

pub fn required(name: impl Into<String>, description: impl Into<String>) -> Self

Create a required parameter with no default.

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

Create an optional parameter with a default value.

Trait Implementations

impl Clone for TemplateParameter

fn clone(&self) -> TemplateParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TemplateParameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TemplateParameter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TemplateParameter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.