Struct Server 

pub struct Server {
    pub url: String,
    pub name: Option<String>,
    pub description: Option<String>,
    pub variables: Map<ServerVariable>,
    pub extensions: Extensions,
}

A server hosting the API.

Kynos never infers this from a bind address. The description states the public URL clients use, which is frequently not the socket the process listens on.

Fields

url: String

A URL to the target host, optionally templated with {variable}.

May be relative to the location the description is served from. Query string and fragment components are not permitted.

name: Option<String>

A name for the server, for use by tooling.

Introduced in OpenAPI 3.2.

description: Option<String>

A description of the host designated by the URL.

variables: Map<ServerVariable>

A map between a variable name and its value, for URL substitution.

extensions: Extensions

Specification extensions.

Implementations

impl Server

pub fn new(url: impl Into<String>) -> Self

Creates a server at the given URL.

pub fn with_description(self, description: impl Into<String>) -> Self

Sets the description.

pub fn with_variable( self, name: impl Into<String>, variable: ServerVariable, ) -> Self

Declares a substitution variable used in the URL template.

Trait Implementations

impl Clone for Server

fn clone(&self) -> Self

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 Default for Server

fn default() -> Self

Returns the “default value” for a type.

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 Eq for Server

impl PartialEq for Server

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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.

impl StructuralPartialEq for Server