Struct PropertySchema 

pub struct PropertySchema {
    pub property_type: PropertyType,
    pub description: Option<String>,
    pub default: Option<PluginValue>,
}

Schema for a property.

Fields

property_type: PropertyType

Property type.

description: Option<String>

Description.

default: Option<PluginValue>

Default value.

Implementations

impl PropertySchema

pub fn string() -> PropertySchema

Creates a string property schema.

pub fn boolean() -> PropertySchema

Creates a boolean property schema.

pub fn integer() -> PropertySchema

Creates an integer property schema.

pub fn with_description(self, description: impl Into<String>) -> PropertySchema

Sets the description.

pub fn with_default(self, default: PluginValue) -> PropertySchema

Sets the default value.

Trait Implementations

impl Clone for PropertySchema

fn clone(&self) -> PropertySchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PropertySchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PropertySchema

fn deserialize<__D>( __deserializer: __D, ) -> Result<PropertySchema, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PropertySchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.