Struct FieldSpec 

#[non_exhaustive]
pub struct FieldSpec {
    pub name: Cow<'static, str>,
    pub kind: FieldKind,
    pub required: bool,
    pub records: bool,
    pub default: Option<Cow<'static, str>>,
    pub primary: bool,
    pub description: Option<Cow<'static, str>>,
}

One field of a config.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Cow<'static, str>

The authored key.

kind: FieldKind

What the field is.

required: bool

Is the key required?

records: bool

Does the engine record the field’s result? Always for a field holding an output.

default: Option<Cow<'static, str>>

The default, as JSON text.

primary: bool

Is this the primary output?

description: Option<Cow<'static, str>>

The field’s doc comment.

Implementations

impl FieldSpec

pub fn runtime( name: impl Into<Cow<'static, str>>, kind: FieldKind, required: bool, ) -> Self

A runtime field: its kind is an expression, an interpolated document, a literal or an output. It records when it holds an output.

pub fn with_default(self, json: impl Into<Cow<'static, str>>) -> Self

Sets the default, as JSON text.

Trait Implementations

impl Clone for FieldSpec

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 FieldSpec

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

Formats the value using the given formatter.