Struct Server 

pub struct Server {
    pub url: String,
    pub description: Option<String>,
    pub variables: Option<BTreeMap<String, ServerVariable>>,
}

Server connectivity information.

Represents a server that provides connectivity to the target API. The URL may contain variables enclosed in curly braces which are substituted using values from the variables map.

Example

use product_os_openapi::{Server, ServerVariable};
use std::collections::BTreeMap;

let mut variables = BTreeMap::new();
variables.insert("environment".to_owned(), ServerVariable {
    default: "production".to_owned(),
    enumeration: Some(vec!["production".to_owned(), "staging".to_owned()]),
    description: Some("Environment name".to_owned()),
});

let server = Server {
    url: "https://{environment}.example.com".to_owned(),
    description: Some("Main API server".to_owned()),
    variables: Some(variables),
};

Fields

url: String

The URL to the target host. May contain variables in curly braces.

description: Option<String>

An optional description of the host. CommonMark syntax may be used.

variables: Option<BTreeMap<String, ServerVariable>>

A map of variable name to its value substitution information.

Trait Implementations

impl Clone for Server

fn clone(&self) -> Server

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Server

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Server

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

where __S: Serializer,

Serialize this value into the given Serde serializer.