Struct ServerVariable 

pub struct ServerVariable {
    pub enumeration: Option<Vec<String>>,
    pub default_value: String,
    pub description: Option<String>,
    pub extensions: Extensions,
}

A substitution variable for a templated Server::url.

Fields

enumeration: Option<Vec<String>>

The set of values this variable may take.

When present it must not be empty, and must contain default_value.

default_value: String

The value to use for substitution when none is supplied.

Unlike JSON Schema’s default, this field is required.

description: Option<String>

A description of this variable. CommonMark syntax may be used.

extensions: Extensions

Specification extensions.

Implementations

impl ServerVariable

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

Creates a free-form variable with the given default.

pub fn enumerated( default_value: impl Into<String>, values: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Creates a variable constrained to a fixed set of values.

Trait Implementations

impl Clone for ServerVariable

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 ServerVariable

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

Formats the value using the given formatter.

impl Default for ServerVariable

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServerVariable

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ServerVariable

impl PartialEq for ServerVariable

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ServerVariable

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 ServerVariable