Server

Struct Server 

Source
pub struct Server {
    pub host: String,
    pub protocol: String,
    pub pathname: Option<String>,
    pub description: Option<String>,
    pub variables: Option<HashMap<String, ServerVariable>>,
}
Expand description

Server connection information

Defines connection details for a server that hosts the API. Multiple servers can be defined to support different environments (production, staging, development).

§Example

use asyncapi_rust_models::{Server, ServerVariable};
use std::collections::HashMap;

let mut variables = HashMap::new();
variables.insert("userId".to_string(), ServerVariable {
    description: Some("User ID for connection".to_string()),
    default: None,
    enum_values: None,
    examples: Some(vec!["12".to_string(), "13".to_string()]),
});

let server = Server {
    host: "chat.example.com:443".to_string(),
    protocol: "wss".to_string(),
    pathname: Some("/api/ws/{userId}".to_string()),
    description: Some("Production WebSocket server".to_string()),
    variables: Some(variables),
};

Fields§

§host: String

Server URL or host

The hostname or URL where the server is hosted. May include port number. Examples: “localhost:8080”, “api.example.com”, “ws.example.com:443”

§protocol: String

Protocol (e.g., “wss”, “ws”, “grpc”)

The protocol used to communicate with the server. Common values: “ws” (WebSocket), “wss” (WebSocket Secure), “grpc”, “mqtt”

§pathname: Option<String>

Optional pathname for the server URL

The pathname to append to the host. Can contain variables in curly braces (e.g., “/api/ws/{userId}”)

§description: Option<String>

Server description

An optional human-readable description of the server’s purpose or environment

§variables: Option<HashMap<String, ServerVariable>>

Server variables

A map of variable name to ServerVariable definition for variables used in the pathname

Trait Implementations§

Source§

impl Clone for Server

Source§

fn clone(&self) -> Server

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Server

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Server

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Server

Source§

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. Read more

Auto Trait Implementations§

§

impl Freeze for Server

§

impl RefUnwindSafe for Server

§

impl Send for Server

§

impl Sync for Server

§

impl Unpin for Server

§

impl UnwindSafe for Server

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,