Struct Parameter 

pub struct Parameter {
    pub description: Option<String>,
    pub schema: Option<Schema>,
}

Channel parameter definition

Defines a parameter that can be used in the channel address. Parameters are substituted at runtime with actual values and have associated schema definitions.

Example

use asyncapi_rust_models::{Parameter, Schema, SchemaObject};
use std::collections::HashMap;

let user_id_param = Parameter {
    description: Some("User ID for this WebSocket connection".to_string()),
    schema: Some(Schema::Object(Box::new(SchemaObject {
        schema_type: Some(serde_json::json!("integer")),
        properties: None,
        required: None,
        description: None,
        title: None,
        enum_values: None,
        const_value: None,
        items: None,
        additional_properties: None,
        one_of: None,
        any_of: None,
        all_of: None,
        additional: HashMap::new(),
    }))),
};

Fields

description: Option<String>

Parameter description

Human-readable description of what this parameter represents

schema: Option<Schema>

Parameter schema

The JSON Schema definition for this parameter’s type and validation rules

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Parameter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Parameter

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.