Struct ServerVariable 

pub struct ServerVariable {
    pub description: Option<String>,
    pub default: Option<String>,
    pub enum_values: Option<Vec<String>>,
    pub examples: Option<Vec<String>>,
}

Server variable definition

Defines a variable that can be used in the server pathname. Variables are substituted at runtime with actual values.

Example

use asyncapi_rust_models::ServerVariable;

let user_id_var = ServerVariable {
    description: Some("Authenticated user ID".to_string()),
    default: None,
    enum_values: None,
    examples: Some(vec!["12".to_string(), "13".to_string()]),
};

Fields

description: Option<String>

Variable description

Human-readable description of what this variable represents

default: Option<String>

Default value

The default value to use if no value is provided

enum_values: Option<Vec<String>>

Enumeration of allowed values

If specified, only these values are valid for this variable

examples: Option<Vec<String>>

Example values

A list of example values for documentation purposes

Trait Implementations

impl Clone for ServerVariable

fn clone(&self) -> ServerVariable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerVariable

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServerVariable

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ServerVariable

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.