Struct ConfigurationField

pub struct ConfigurationField {
    pub description: Option<String>,
    pub name: String,
    pub options: Option<Vec<String>>,
    pub required: bool,
    pub secret: Option<bool>,
    pub title: String,
    pub type_: ConfigurationFieldType,
}

ConfigurationField

JSON schema

{
 "type": "object",
 "required": [
   "name",
   "required",
   "title",
   "type"
 ],
 "properties": {
   "description": {
     "description": "The description of the configuration field.",
     "type": "string"
   },
   "name": {
     "description": "The name of the configuration field.",
     "type": "string"
   },
   "options": {
     "description": "The options of the configuration field (only for string type).",
     "type": [
       "array",
       "null"
     ],
     "items": {
       "type": "string"
     }
   },
   "required": {
     "description": "Whether the configuration field is required.",
     "type": "boolean"
   },
   "secret": {
     "description": "Whether the configuration field is a secret.",
     "type": "boolean"
   },
   "title": {
     "description": "The title of the configuration field.",
     "type": "string"
   },
   "type": {
     "description": "The type of the configuration field.",
     "type": "string",
     "enum": [
       "string",
       "bool",
       "number"
     ]
   }
 }
}

Fields

description: Option<String>

The description of the configuration field.

name: String

The name of the configuration field.

options: Option<Vec<String>>

The options of the configuration field (only for string type).

required: bool

Whether the configuration field is required.

secret: Option<bool>

Whether the configuration field is a secret.

title: String

The title of the configuration field.

type_: ConfigurationFieldType

The type of the configuration field.

Implementations

impl ConfigurationField

pub fn builder() -> ConfigurationField

Trait Implementations

impl Clone for ConfigurationField

fn clone(&self) -> ConfigurationField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigurationField

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigurationField

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ConfigurationField> for ConfigurationField

fn from(value: &ConfigurationField) -> Self

Converts to this type from the input type.

impl From<ConfigurationField> for ConfigurationField

fn from(value: ConfigurationField) -> Self

Converts to this type from the input type.

impl JsonSchema for ConfigurationField

fn schema_name() -> String

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 is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for ConfigurationField

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<ConfigurationField> for ConfigurationField

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: ConfigurationField) -> Result<Self, ConversionError>

Performs the conversion.