Struct poem::Response

pub struct Response { /* private fields */ }

Expand description

Represents an HTTP response.

Implementations§

impl Response

pub fn from_parts(parts: ResponseParts, body: Body) -> Self

Creates a new Response with the given head and body.

pub fn builder() -> ResponseBuilder

Creates a response builder.

pub fn status(&self) -> StatusCode

Returns the associated status code.

pub fn is_ok(&self) -> bool

Returns true if status code is StatusCode::OK.

pub fn is_success(&self) -> bool

Check if status is within 200-299.

pub fn set_status(&mut self, status: StatusCode)

Sets the status code for this response.

pub fn content_type(&self) -> Option<&str>

Returns the content type of this response.

pub fn set_content_type(self, content_type: impl AsRef<str>) -> Self

Sets the Content-Type header on the response.

pub fn headers(&self) -> &HeaderMap

Returns a reference to the associated header map.

pub fn headers_mut(&mut self) -> &mut HeaderMap

Returns a mutable reference to the associated header map.

Returns the string value of the specified header.

NOTE: Returns None if the header value is not a valid UTF8 string.

pub fn version(&self) -> Version

Returns the associated version.

pub fn set_version(&mut self, version: Version)

Sets the version for this response.

pub fn extensions(&self) -> &Extensions

Returns a reference to the associated extensions.

pub fn extensions_mut(&mut self) -> &mut Extensions

Returns a mutable reference to the associated extensions.

pub fn data<T: Send + Sync + 'static>(&self) -> Option<&T>

Get a reference from extensions, similar to self.extensions().get().

pub fn set_data(&mut self, data: impl Clone + Send + Sync + 'static)

Inserts a value to extensions, similar to self.extensions().insert(data).

pub fn set_body(&mut self, body: impl Into<Body>)

Sets the body for this response.

pub fn take_body(&mut self) -> Body

Take the body from this response and sets the body to empty.

pub fn into_body(self) -> Body

Consume this response and return its inner body.

pub fn into_parts(self) -> (ResponseParts, Body)

Consumes the response returning the head and body parts.

Trait Implementations§

impl Debug for Response

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Default for Response

fn default() -> Response

Returns the “default value” for a type. Read more

impl<T: Into<Body>> From<(StatusCode, T)> for Response

fn from((status, body): (StatusCode, T)) -> Self

Converts to this type from the input type.

impl<T> From<Response<T>> for Response
where T: Body + Send + Sync + 'static, T::Data: Into<Bytes>, T::Error: Into<Error>,

fn from(hyper_resp: Response<T>) -> Self

Converts to this type from the input type.

impl From<Response> for Response<BoxBody<Bytes, Error>>

fn from(resp: Response) -> Self

Converts to this type from the input type.

impl From<StatusCode> for Response

fn from(status: StatusCode) -> Self

Converts to this type from the input type.

impl<T: Into<Body>> From<T> for Response

fn from(body: T) -> Self

Converts to this type from the input type.

impl IntoResponse for Response

fn into_response(self) -> Response

Consume itself and return Response.

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

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

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

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

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 Freeze for Response

impl !RefUnwindSafe for Response

impl Send for Response

impl Sync for Response

impl Unpin for Response

impl !UnwindSafe for Response

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

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

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

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> TowerCompatExt for T

fn compat<ResBody, Err, Fut>(self) -> TowerCompatEndpoint<Self>
where ResBody: Body + Send + Sync + 'static, ResBody::Data: Into<Bytes> + Send + 'static, ResBody::Error: StdError + Send + Sync + 'static, Err: Into<Error>, Self: Service<Request<BoxBody<Bytes, Error>>, Response = Response<ResBody>, Error = Err, Future = Fut> + Clone + Send + Sync + Sized + 'static, Fut: Future<Output = Result<Response<ResBody>, Err>> + Send + 'static,

Available on crate feature tower-compat only.

Converts a tower service to a poem endpoint.

impl<L> TowerLayerCompatExt for L

fn compat(self) -> TowerCompatMiddleware<Self>
where Self: Sized,

Available on crate feature tower-compat only.

Converts a tower layer to a poem middleware.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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