Struct Channel 

pub struct Channel {
    pub address: Option<String>,
    pub messages: Option<HashMap<String, MessageRef>>,
    pub parameters: Option<HashMap<String, Parameter>>,
}

Communication channel

Represents a communication path through which messages are exchanged. Channels define where messages are sent and received (e.g., WebSocket endpoints, message queue topics, gRPC methods).

Example

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

let mut parameters = HashMap::new();
parameters.insert("userId".to_string(), 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(),
    }))),
});

let channel = Channel {
    address: Some("/ws/chat/{userId}".to_string()),
    messages: None,
    parameters: Some(parameters),
};

Fields

address: Option<String>

Channel address/path

The location where this channel is available. For WebSocket, this is typically the WebSocket path (e.g., “/ws/chat”). For other protocols, this could be a topic name, queue name, or method path.

messages: Option<HashMap<String, MessageRef>>

Messages available on this channel

A map of message identifiers to message definitions or references. Messages define the structure of data that flows through this channel.

parameters: Option<HashMap<String, Parameter>>

Channel parameters

A map of parameter names to their schema definitions for variables used in the address

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Channel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Channel

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Channel

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.