Struct ExampleBuilder

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

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

Implementations

impl<S: State> ExampleBuilder<S>

pub fn build(self) -> Example

where S: IsComplete,

Finish building and return the requested object

pub fn summary(self, value: impl Into<String>) -> ExampleBuilder<SetSummary<S>>

where S::Summary: IsUnset,

Required.

Short description for the Example.

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

where S::Description: IsUnset,

Required.

Long description for the Example. Value supports markdown syntax for rich text representation.

pub fn value(self, value: impl Into<Value>) -> ExampleBuilder<SetValue<S>>

where S::Value: IsUnset,

Optional (Some / Option setters).

Embedded literal example value. Example::value and Example::external_value are mutually exclusive.

pub fn maybe_value( self, value: Option<impl Into<Value>>, ) -> ExampleBuilder<SetValue<S>>

where S::Value: IsUnset,

Optional (Some / Option setters).

Embedded literal example value. Example::value and Example::external_value are mutually exclusive.

pub fn external_value( self, value: impl Into<String>, ) -> ExampleBuilder<SetExternalValue<S>>

where S::ExternalValue: IsUnset,

Required.

An URI that points to a literal example value. Example::external_value provides the capability to references an example that cannot be easily included in JSON or YAML. Example::value and Example::external_value are mutually exclusive.

Trait Implementations

impl<S: IsComplete> From<ExampleBuilder<S>> for Example

fn from(builder: ExampleBuilder<S>) -> Self

Converts to this type from the input type.

impl<S: IsComplete> From<ExampleBuilder<S>> for RefOr<Example>

fn from(builder: ExampleBuilder<S>) -> Self

Converts to this type from the input type.