Struct ConfigExample 

pub struct ConfigExample {
    pub description: String,
    pub config: JsonMessage,
}

Fields

description: String

A description of what this config is for

config: JsonMessage

The value of the config

Implementations

impl ConfigExample

pub fn new(description: impl ToString, config: impl Serialize) -> Self

Create a new config example.

Note that this function will panic if the config argument fails to be serialized into a JsonMessage, which happens if the data structure contains a map with non-string keys or its Serialize implementation produces an error. It’s recommended to only use this during application startup to avoid runtime failures.

To construct a ConfigExample with no risk of panicking, you can directly use normal structure initialization.

Trait Implementations

impl Clone for ConfigExample

fn clone(&self) -> ConfigExample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl JsonSchema for ConfigExample

fn schema_name() -> Cow<'static, str>

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

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn always_inline_schema() -> bool

👎Deprecated:

Use inline_schema() instead

Only included for backward-compatibility - use inline_schema() instead“.

impl Serialize for ConfigExample

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

where __S: Serializer,

Serialize this value into the given Serde serializer.