Struct VariableV1 

pub struct VariableV1 {
    pub description: Option<String>,
    pub required: bool,
    pub default: Option<String>,
    pub secret: bool,
}

The name of the application variable.

Fields

description: Option<String>

A brief description of the variable.

Example: description = "This is a variable"

Learn more: https://spinframework.dev/variables#adding-variables-to-your-applications

required: bool

Whether a value must be supplied at runtime. If not specified, required defaults to false, and default must be provided.

Example: required = true

Learn more: https://spinframework.dev/variables#adding-variables-to-your-applications

default: Option<String>

The value of the variable if no value is supplied at runtime. If specified, the value must be a string. If not specified, required`` must be true`.

Example: default = "default value"

Learn more: https://spinframework.dev/variables#adding-variables-to-your-applications

secret: bool

If set, this variable should be treated as sensitive.

Example: secret = true

Learn more: https://spinframework.dev/variables#adding-variables-to-your-applications

Trait Implementations

impl Clone for Variable

fn clone(&self) -> Variable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Variable

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Variable

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Variable

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 Serialize for Variable

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

where __S: Serializer,

Serialize this value into the given Serde serializer.