Struct poem_openapi::payload::Response
source · [−]pub struct Response<T> { /* private fields */ }Expand description
A response type wrapper.
Use it to modify the status code and HTTP headers.
Implementations
sourceimpl<T> Response<T>
impl<T> Response<T>
sourcepub fn status(self, status: StatusCode) -> Self
pub fn status(self, status: StatusCode) -> Self
Sets the HTTP status for this response.
sourcepub fn header<K, V>(self, key: K, value: V) -> Self where
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,
pub fn header<K, V>(self, key: K, value: V) -> Self where
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,
Appends a header to this response.
Trait Implementations
sourceimpl<T: ApiResponse> ApiResponse for Response<T>
impl<T: ApiResponse> ApiResponse for Response<T>
sourceconst BAD_REQUEST_HANDLER: bool
const BAD_REQUEST_HANDLER: bool
If true, it means that the response object has a custom bad request handler. Read more
sourcefn register(registry: &mut Registry)
fn register(registry: &mut Registry)
Register the schema contained in this response object to the registry.
sourcefn from_parse_request_error(err: Error) -> Self
fn from_parse_request_error(err: Error) -> Self
Convert poem::Error to this response object.
sourceimpl<T: IntoResponse> IntoResponse for Response<T>
impl<T: IntoResponse> IntoResponse for Response<T>
sourcefn into_response(self) -> Response
fn into_response(self) -> Response
Consume itself and return Response.
sourcefn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self> where
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,
fn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self> where
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,
Wrap an impl IntoResponse to add a header. Read more
sourcefn with_content_type<V>(self, content_type: V) -> WithContentType<Self> where
V: TryInto<HeaderValue>,
fn with_content_type<V>(self, content_type: V) -> WithContentType<Self> where
V: TryInto<HeaderValue>,
Wrap an impl IntoResponse to with a new content type. Read more
sourcefn with_status(self, status: StatusCode) -> WithStatus<Self>
fn with_status(self, status: StatusCode) -> WithStatus<Self>
Wrap an impl IntoResponse to set a status code. Read more
Auto Trait Implementations
impl<T> RefUnwindSafe for Response<T> where
T: RefUnwindSafe,
impl<T> Send for Response<T> where
T: Send,
impl<T> Sync for Response<T> where
T: Sync,
impl<T> Unpin for Response<T> where
T: Unpin,
impl<T> UnwindSafe for Response<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> IntoResult<T> for T where
T: IntoResponse,
impl<T> IntoResult<T> for T where
T: IntoResponse,
sourcefn into_result(self) -> Result<T, Error>
fn into_result(self) -> Result<T, Error>
Consumes this value returns a poem::Result<T>.
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more