Struct ServerVariable

#[non_exhaustive]
pub struct ServerVariable {
    pub default_value: String,
    pub description: Option<String>,
    pub enum_values: Option<Vec<String>>,
    pub extensions: Option<Extensions>,
}

Implements OpenAPI Server Variable used to substitute variables in Server::url.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

default_value: String

Default value used to substitute parameter if no other value is being provided.

description: Option<String>

Optional description describing the variable of substitution. Markdown syntax is supported.

enum_values: Option<Vec<String>>

Enum values can be used to limit possible options for substitution. If enum values is used the ServerVariable::default_value must contain one of the enum values.

extensions: Option<Extensions>

Optional extensions “x-something”.

Implementations

impl ServerVariable

pub fn builder() -> ServerVariableBuilder

Construct a new ServerVariableBuilder.

This is effectively same as calling ServerVariableBuilder::new

Trait Implementations

impl Clone for ServerVariable

fn clone(&self) -> ServerVariable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ServerVariable

fn default() -> ServerVariable

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 From<ServerVariable> for ServerVariableBuilder

fn from(value: ServerVariable) -> Self

Converts to this type from the input type.

impl From<ServerVariableBuilder> for ServerVariable

fn from(value: ServerVariableBuilder) -> Self

Converts to this type from the input type.

impl PartialEq for ServerVariable

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

impl StructuralPartialEq for ServerVariable