Struct ConfigSchema 

pub struct ConfigSchema {
    pub version: String,
    pub properties: HashMap<String, ConfigProperty>,
    pub required: Vec<String>,
}

Plugin configuration schema

Fields

version: String

Schema format version

properties: HashMap<String, ConfigProperty>

Configuration properties

required: Vec<String>

Required properties

Implementations

impl ConfigSchema

pub fn new() -> ConfigSchema

Create new config schema

pub fn add_property(&mut self, name: String, property: ConfigProperty)

Add a property to the schema

pub fn require(&mut self, name: &str)

Mark a property as required

pub fn validate(&self) -> Result<(), PluginError>

Validate the schema

pub fn validate_config(&self, config: &Value) -> Result<(), PluginError>

Validate configuration against schema

pub fn get_property(&self, name: &str) -> Option<&ConfigProperty>

Get property by name

pub fn is_required(&self, name: &str) -> bool

Check if property is required

Trait Implementations

impl Clone for ConfigSchema

fn clone(&self) -> ConfigSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigSchema

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

Formats the value using the given formatter.

impl Default for ConfigSchema

fn default() -> ConfigSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConfigSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ConfigSchema

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.