Struct aide::transform::TransformResponse

pub struct TransformResponse<'t, T> { /* private fields */ }

A transform helper that wraps Response.

An additional type is provided for strongly-typed examples.

Implementations

impl<'t, T> TransformResponse<'t, T>

pub fn new(response: &'t mut Response) -> Self

Create a new transform helper.

pub fn hidden(self, hidden: bool) -> Self

Hide the response from the documentation.

This is taken into account by generators provided by this library.

Hiding an item causes it to be ignored completely, there is no way to restore or “unhide” it afterwards.

pub fn description(self, desc: &str) -> Self

Provide or override the description of the response.

pub fn example(self, example: impl Into<T>) -> Selfwhere T: Serialize,

Provide or override an example for the response.

pub fn with(self, transform: impl FnOnce(Self) -> Self) -> Self

Apply an another transform function.

pub fn inner(&mut self) -> &mut Response

Access the inner Response.