Struct OptionField 

pub struct OptionField {
    pub name: String,
    pub ty: OptionType,
    pub description: String,
    pub required: bool,
    pub default: Option<Value>,
    pub choices: Vec<String>,
    pub min: Option<f64>,
    pub max: Option<f64>,
}

One option a plugin takes.

Fields

name: String

ty: OptionType

description: String

required: bool

default: Option<Value>

choices: Vec<String>

The only values a string option may take.

min: Option<f64>

Bounds for integer and number, inclusive.

max: Option<f64>

Implementations

impl OptionField

pub fn new(name: &str, ty: OptionType, description: &str) -> Self

pub fn required(self) -> Self

pub fn default(self, v: impl Into<Value>) -> Self

pub fn choices(self, c: &[&str]) -> Self

pub fn range(self, min: Option<f64>, max: Option<f64>) -> Self

Trait Implementations

impl Clone for OptionField

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 OptionField

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OptionField

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for OptionField

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 OptionField

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OptionField

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 OptionField