Struct SchemaField 

pub struct SchemaField {
    pub name: String,
    pub schema: ConfigSchema,
    pub required: bool,
    pub doc: String,
}

One field of a ConfigSchema::Record.

doc is carried per field rather than only per option because that is what :describe-option and :customize render beside the field — an option-level doc string describing six fields is the wall of prose the schema exists to replace.

Fields

name: String

The field’s key in the record (and in TOML). Matched exactly.

schema: ConfigSchema

The shape the field’s value must have.

required: bool

A missing required field is a validation error naming its path; a missing optional one is simply absent from the value.

doc: String

Per-field help rendered beside the field.

Implementations

impl SchemaField

pub fn new( name: impl Into<String>, schema: ConfigSchema, doc: impl Into<String>, ) -> Self

A required field. The common case, so it is the short constructor.

pub fn optional(self) -> Self

Builder: make this field optional.

Trait Implementations

impl Clone for SchemaField

fn clone(&self) -> SchemaField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaField

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

Formats the value using the given formatter.

impl Eq for SchemaField

impl PartialEq for SchemaField

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SchemaField