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.
Examples
use poem::{
error::BadRequest,
http::{Method, StatusCode, Uri},
test::TestClient,
Body, IntoEndpoint, Request, Result,
};
use poem_openapi::{
payload::{Json, Response},
OpenApi, OpenApiService,
};
use tokio::io::AsyncReadExt;
struct MyApi;
#[OpenApi]
impl MyApi {
#[oai(path = "/test", method = "get")]
async fn test(&self) -> Response<Json<i32>> {
Response::new(Json(100)).header("foo", "bar")
}
}
let api = OpenApiService::new(MyApi, "Demo", "0.1.0");
let resp = TestClient::new(api).get("/test").send().await;
resp.assert_status_is_ok();
resp.assert_header("foo", "bar");
resp.assert_text("100").await;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) -> Selfwhere
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,
pub fn header<K, V>(self, key: K, value: V) -> Selfwhere
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 = T::BAD_REQUEST_HANDLER
const BAD_REQUEST_HANDLER: bool = T::BAD_REQUEST_HANDLER
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 moresourcefn 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 moresourcefn 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 moreAuto 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 Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
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 Twhere
T: IntoResponse,
impl<T> IntoResult<T> for Twhere
T: IntoResponse,
sourcefn into_result(self) -> Result<T, Error>
fn into_result(self) -> Result<T, Error>
Consumes this value returns a
poem::Result<T>.