Struct ServerBuilder

pub struct ServerBuilder<S: State = Empty> { /* private fields */ }

Use builder syntax to set the inputs and finish with build().

Implementations

impl<S: State> ServerBuilder<S>

pub fn build(self) -> Server

where S: IsComplete,

Finish building and return the requested object

pub fn url(self, value: impl Into<String>) -> ServerBuilder<SetUrl<S>>

where S::Url: IsUnset,

Required.

Target url of the Server. It can be valid http url or relative path.

Url also supports variable substitution with {variable} syntax. The substitutions then can be configured with Server::variables map.

pub fn description( self, value: impl Into<String>, ) -> ServerBuilder<SetDescription<S>>

where S::Description: IsUnset,

Optional (Some / Option setters).

Optional description describing the target server url. Description supports markdown syntax.

pub fn maybe_description( self, value: Option<impl Into<String>>, ) -> ServerBuilder<SetDescription<S>>

where S::Description: IsUnset,

Optional (Some / Option setters).

Optional description describing the target server url. Description supports markdown syntax.

pub fn extensions( self, value: impl Into<Extensions>, ) -> ServerBuilder<SetExtensions<S>>

where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

pub fn maybe_extensions( self, value: Option<impl Into<Extensions>>, ) -> ServerBuilder<SetExtensions<S>>

where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

impl<S: State> ServerBuilder<S>

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

Add parameter to Server which is used to substitute values in Server::url.

• name Defines name of the parameter which is being substituted within the url. If url has {username} substitution then the name should be username.
• parameter Use ServerVariableBuilder to define how the parameter is being substituted within the url.