Struct ConfigurationSchema 

pub struct ConfigurationSchema {
    pub name: String,
    pub version: String,
    pub description: Option<String>,
    pub sections: Vec<ConfigSection>,
}

Configuration schema definition

Fields

name: String

version: String

description: Option<String>

sections: Vec<ConfigSection>

Implementations

impl ConfigurationSchema

pub fn new(name: impl Into<String>, version: impl Into<String>) -> Self

Create a new configuration schema

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

Set schema description

pub fn add_section(self, section: ConfigSection) -> Self

Add a configuration section

pub fn get_section(&self, name: &str) -> Option<&ConfigSection>

Get section by name

pub fn all_fields(&self) -> Vec<&ConfigField>

Get all fields from all sections

pub fn validate( &self, config: &HashMap<String, Value>, ) -> Result<(), ConfigError>

Validate configuration against this schema

pub fn to_openapi_schema(&self) -> Value

Generate OpenAPI schema

Trait Implementations

impl Clone for ConfigurationSchema

fn clone(&self) -> ConfigurationSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigurationSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigurationSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ConfigurationSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.