Struct Field 

pub struct Field {
    pub path: String,
    pub kind: String,
    pub description: String,
    pub default: Option<String>,
    pub allowed: Vec<(String, String)>,
    pub limits: Vec<String>,
    pub examples: Vec<String>,
    pub members: Vec<String>,
}

One field of the spec as the reference shows it.

Fields

path: String

Its path: * for a name the author chooses, [] for the items of a list (machines.*.ports[].port).

kind: String

Its type in words (string, list of mappings, map of name to integer).

description: String

What it is for, from the model’s doc comment.

default: Option<String>

Its default value as JSON, when the schema states one worth showing.

allowed: Vec<(String, String)>

The values it accepts, each with what it means, when it is a closed set.

limits: Vec<String>

Ranges and patterns the schema enforces beyond the type.

examples: Vec<String>

Examples the schema carries.

members: Vec<String>

For a shallow field (common, groups), the names of the fields it holds.

Trait Implementations

impl Clone for Field

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 Field

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

Formats the value using the given formatter.

impl Default for Field

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Field

impl PartialEq for Field

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Field