Struct ComponentSchema 

pub struct ComponentSchema {
    pub name: String,
    pub description: String,
    pub properties: HashMap<String, PropertySchema>,
    pub required: Vec<String>,
}

Schema for a component.

Fields

name: String

Component name.

description: String

Description.

properties: HashMap<String, PropertySchema>

Configuration properties.

required: Vec<String>

Required properties.

Implementations

impl ComponentSchema

pub fn new(name: impl Into<String>) -> ComponentSchema

Creates a new component schema.

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

Sets the description.

pub fn with_property( self, name: impl Into<String>, schema: PropertySchema, ) -> ComponentSchema

Adds a property.

pub fn require(self, name: impl Into<String>) -> ComponentSchema

Marks a property as required.

Trait Implementations

impl Clone for ComponentSchema

fn clone(&self) -> ComponentSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentSchema

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

Formats the value using the given formatter.

impl Default for ComponentSchema

fn default() -> ComponentSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ComponentSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ComponentSchema

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.