Struct AuthoredInput 

pub struct AuthoredInput {

    pub kind: StackInputKind,
    pub provided_by: Vec<StackInputProvider>,
    pub required: bool,
    pub label: String,
    pub description: String,
    pub placeholder: Option<String>,
    pub default: Option<InputValue>,
    pub when: Option<StackInputCondition>,
    pub platforms: Option<Vec<Platform>>,
    pub env: Vec<AuthoredEnvMapping>,
    pub generate: Option<StackInputGenerate>,
    pub min_length: Option<u32>,
    pub max_length: Option<u32>,
    pub pattern: Option<String>,
    pub format: Option<String>,
    pub min: Option<InputValue>,
    pub max: Option<InputValue>,
    pub values: Option<Vec<String>>,
    pub min_items: Option<u32>,
    pub max_items: Option<u32>,
}

A stack input as written in a stack file.

Fields

kind: StackInputKind

Input primitive kind.

provided_by: Vec<StackInputProvider>

Who can provide the value. The developer when unset.

required: bool

Whether a value is needed before deployment can proceed. True when unset.

label: String

Human-facing field label.

description: String

Helper text shown where the value is asked for. Required when the input is.

placeholder: Option<String>

Example shown in the field.

default: Option<InputValue>

Value used when none is provided. Secrets have none.

when: Option<StackInputCondition>

Only applies when a boolean input has this value.

platforms: Option<Vec<Platform>>

Platforms where the input applies.

env: Vec<AuthoredEnvMapping>

Environment variables the value is delivered as.

generate: Option<StackInputGenerate>

Let Alien generate the value. Secret, developer-provided inputs only.

min_length: Option<u32>

Shortest string, for string and secret inputs.

max_length: Option<u32>

Longest string, for string and secret inputs.

pattern: Option<String>

Whole-value pattern, for string and secret inputs.

format: Option<String>

Semantic format such as url, for string and secret inputs.

min: Option<InputValue>

Smallest value, for number and integer inputs.

max: Option<InputValue>

Largest value, for number and integer inputs.

values: Option<Vec<String>>

Accepted values, for enum inputs.

min_items: Option<u32>

Fewest items, for string-list inputs.

max_items: Option<u32>

Most items, for string-list inputs.

Implementations

impl AuthoredInput

pub fn into_definition(self, id: &str) -> Result<StackInputDefinition>

The definition this input becomes under id.

Trait Implementations

impl Clone for AuthoredInput

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthoredInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthoredInput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AuthoredInput

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for AuthoredInput

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 AuthoredInput