Struct TemplateVariable 

pub struct TemplateVariable { /* private fields */ }

One variable of a template’s declared set, merged down its chain.

Built only by loading a template, so items is present exactly when type is list, a default is a value of the variable’s type, and required is never true beside one.

Implementations

impl TemplateVariable

pub fn name(&self) -> &str

The variable’s name.

pub fn description(&self) -> &str

What the variable is for.

pub fn kind(&self) -> VariableType

What the variable holds.

pub fn items(&self) -> Option<ItemType>

What each entry holds, for a list variable.

pub fn required(&self) -> bool

Whether rendering without an answer is refused.

pub fn default(&self) -> Option<&Value>

The value used when no answer is given.

pub fn declared_in(&self) -> &str

The chain file whose declaration this is.

pub fn multi_line(&self) -> bool

Whether a value of this variable is written over several lines: text, list and object.

pub fn parse(&self, text: &str) -> Result<Value, String>

Read text as this variable’s value: literally for string and text, as YAML for every other type — the rule --var and a prompt both follow.

Errors

Why the text is not a value of this variable’s type.

pub fn check(&self, value: &Value) -> Result<(), String>

Whether value is a value of this variable’s type.

Errors

Why it is not.

Trait Implementations

impl Clone for TemplateVariable

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 TemplateVariable

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

Formats the value using the given formatter.

impl JsonSchema for TemplateVariable

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 PartialEq for TemplateVariable

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TemplateVariable

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 TemplateVariable