HttpApiResponse

poem_http_common::response

Enum HttpApiResponse 

Source 
pub enum HttpApiResponse<T>
where
    T: ParseFromJSON + ToJSON + Send + Sync,
{
    Ok(Json<T>),
    Created(Json<T>),
    MovedPermanently(Json<RedirectResponse>),
    Found(Json<RedirectResponse>),
    BadRequest(Json<ErrorResponse>),
    Unauthorized(Json<ErrorResponse>),
    Forbidden(Json<ErrorResponse>),
    NotFound(Json<ErrorResponse>),
    TooManyRequest(Json<ErrorResponse>),
    InternalServerError(Json<ErrorResponse>),
    BadGateway(Json<ErrorResponse>),
    ServiceUnavailable(Json<ErrorResponse>),
}

Variants§

§

Ok(Json<T>)

§

Created(Json<T>)

§

MovedPermanently(Json<RedirectResponse>)

§

Found(Json<RedirectResponse>)

§

BadRequest(Json<ErrorResponse>)

§

Unauthorized(Json<ErrorResponse>)

§

Forbidden(Json<ErrorResponse>)

§

NotFound(Json<ErrorResponse>)

§

TooManyRequest(Json<ErrorResponse>)

§

InternalServerError(Json<ErrorResponse>)

§

BadGateway(Json<ErrorResponse>)

§

ServiceUnavailable(Json<ErrorResponse>)

Trait Implementations§

Source§

impl<T> ApiResponse for HttpApiResponse<T>
where T: ParseFromJSON + ToJSON + Send + Sync,

Source§

const BAD_REQUEST_HANDLER: bool = false

If true, it means that the response object has a custom bad request handler.
Source§

fn meta() -> MetaResponses

Gets metadata of this response.
Source§

fn register(registry: &mut Registry)

Register the schema contained in this response object to the registry.
Source§

fn from_parse_request_error(err: Error) -> Self

Convert poem::Error to this response object.
Source§

impl<T> From<HttpApiResponse<T>> for Error
where T: ParseFromJSON + ToJSON + Send + Sync,

Source§

fn from(resp: HttpApiResponse<T>) -> Error

Converts to this type from the input type.
Source§

impl<T> IntoResponse for HttpApiResponse<T>
where T: ParseFromJSON + ToJSON + Send + Sync,

Source§

fn into_response(self) -> Response

Consume itself and return Response.
Source§

fn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self>
where K: TryInto<HeaderName>, V: TryInto<HeaderValue>, Self: Sized,

Wrap an impl IntoResponse to add a header. Read more
Source§

fn with_content_type<V>(self, content_type: V) -> WithContentType<Self>
where V: TryInto<HeaderValue>, Self: Sized,

Wrap an impl IntoResponse to with a new content type. Read more
Source§

fn with_status(self, status: StatusCode) -> WithStatus<Self>
where Self: Sized,

Wrap an impl IntoResponse to set a status code. Read more
Source§

fn with_body(self, body: impl Into<Body>) -> WithBody<Self>
where Self: Sized,

Wrap an impl IntoResponse to set a body. Read more

Auto Trait Implementations§

§

impl<T> Freeze for HttpApiResponse<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for HttpApiResponse<T>
where T: RefUnwindSafe,

§

impl<T> Send for HttpApiResponse<T>

§

impl<T> Sync for HttpApiResponse<T>

§

impl<T> Unpin for HttpApiResponse<T>
where T: Unpin,

§

impl<T> UnwindSafe for HttpApiResponse<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoResult<T> for T
where T: IntoResponse,

Source§

fn into_result(self) -> Result<T, Error>

Consumes this value returns a poem::Result<T>.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more