Struct ResponseBuilder

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

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

Implementations

impl<S: State> ResponseBuilder<S>

pub fn build(self) -> Response

where S: IsComplete,

Finish building and return the requested object

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

where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

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

where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

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

where S::Description: IsUnset,

Required.

Description of the response. Response support markdown syntax.

impl<S: State> ResponseBuilder<S>

pub fn content( self, content_type: impl Into<String>, content: impl Into<Content>, ) -> Self

Add Content of the Response with content type e.g application/json.

pub fn header(self, name: impl Into<String>, header: impl Into<Header>) -> Self

Add response Header.

pub fn link(self, name: impl Into<String>, link: impl Into<RefOr<Link>>) -> Self

Add link that can be followed from the response.

pub fn contents<A: Into<String>, B: Into<Content>>( self, contents: impl IntoIterator<Item = (A, B)>, ) -> Self

Add Content of the Response with content type e.g application/json.

pub fn headers<A: Into<String>, B: Into<Header>>( self, headers: impl IntoIterator<Item = (A, B)>, ) -> Self

Add response Header.

pub fn links<A: Into<String>, B: Into<RefOr<Link>>>( self, links: impl IntoIterator<Item = (A, B)>, ) -> Self

Add link that can be followed from the response.

Trait Implementations

impl<S: IsComplete> From<ResponseBuilder<S>> for RefOr<Response>

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

Converts to this type from the input type.

impl<S: IsComplete> From<ResponseBuilder<S>> for Response

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

Converts to this type from the input type.