Struct ConfigKey 

pub struct ConfigKey {
    pub key: String,
    pub kind: String,
    pub about: String,
    pub default: Option<Value>,
    pub value: Option<Value>,
    pub choices: Vec<String>,
    pub min: Option<f64>,
    pub max: Option<f64>,
    pub required: bool,
}

One key: what it is, what it is set to, and what it is otherwise.

Fields

key: String

The key, e.g. max_turns; dotted below a sub-table (sigstore.identity).

kind: String

bool, integer, number, string, choice, duration, argv, argv_list or string_list.

about: String

What it does.

default: Option<Value>

The value speccoder uses when the key is absent; none for keys without a default (unset means off, or the key is required).

value: Option<Value>

The value in the file, when set.

choices: Vec<String>

For choice: the allowed values.

min: Option<f64>

For numbers: the smallest allowed.

max: Option<f64>

For numbers: the largest allowed.

required: bool

The section (or table) is refused without it.

Trait Implementations

impl Clone for ConfigKey

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 ConfigKey

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

Formats the value using the given formatter.

impl JsonSchema for ConfigKey

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 ConfigKey

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ConfigKey

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 ConfigKey