Struct Parameter

pub struct Parameter {
    pub description: Option<String>,
    pub display_name: Option<String>,
    pub from: Option<String>,
    pub generate: Option<String>,
    pub name: String,
    pub required: Option<bool>,
    pub value: Option<String>,
}

Parameter defines a name/value variable that is to be processed during the Template to Config transformation.

Fields

description: Option<String>

Description of a parameter. Optional.

display_name: Option<String>

Optional: The name that will show in UI instead of parameter ‘Name’

from: Option<String>

From is an input value for the generator. Optional.

generate: Option<String>

generate specifies the generator to be used to generate random string from an input value specified by From field. The result string is stored into Value field. If empty, no generator is being used, leaving the result Value untouched. Optional.

The only supported generator is “expression”, which accepts a “from” value in the form of a simple regular expression containing the range expression “[a-zA-Z0-9]”, and the length expression “a{length}”.

Examples:

from | value —————————– “test[0-9]{1}x” | “test7x” “[0-1]{8}” | “01001100” “0x[A-F0-9]{4}” | “0xB3AF” “[a-zA-Z0-9]{8}” | “hW4yQU5i”

name: String

Name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}. Required.

required: Option<bool>

Optional: Indicates the parameter must have a value. Defaults to false.

value: Option<String>

Value holds the Parameter data. If specified, the generator will be ignored. The value replaces all occurrences of the Parameter ${Name} expression during the Template to Config transformation. Optional.

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl Default for Parameter

fn default() -> Parameter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Parameter

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Parameter

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

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 Parameter