Struct poem::Response

source · [−]

pub struct Response { /* private fields */ }

Expand description

Represents an HTTP response.

Implementations

source

impl Response

source

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

Creates a new Response with the given head and body.

source

pub fn builder() -> ResponseBuilder

Creates a response builder.

source

pub fn status(&self) -> StatusCode

Returns the associated status code.

source

pub fn is_ok(&self) -> bool

Returns true if status code is StatusCode::OK.

source

pub fn is_success(&self) -> bool

Check if status is within 200-299.

source

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

Sets the status code for this response.

source

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

Returns the content type of this response.

source

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

Sets the Content-Type header on the response.

source

pub fn headers(&self) -> &HeaderMap

Returns a reference to the associated header map.

source

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.

source

pub fn version(&self) -> Version

Returns the associated version.

source

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

Sets the version for this response.

source

pub fn extensions(&self) -> &Extensions

Returns a reference to the associated extensions.

source

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

Returns a mutable reference to the associated extensions.

source

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

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

source

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

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

source

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

Sets the body for this response.

source

pub fn take_body(&mut self) -> Body

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

source

pub fn into_body(self) -> Body

Consume this response and return its inner body.

source

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

Consumes the response returning the head and body parts.

Trait Implementations

source

impl Debug for Response

source

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

Formats the value using the given formatter. Read more

source

impl Default for Response

source

fn default() -> Response

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

source

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

source

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

Performs the conversion.

source

impl From<Response<Body>> for Response

source

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

Performs the conversion.

source

impl From<Response> for Response<Body>

source

fn from(resp: Response) -> Self

Performs the conversion.

source

impl From<StatusCode> for Response

source

fn from(status: StatusCode) -> Self

Performs the conversion.

source

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

source

fn from(body: T) -> Self

Performs the conversion.

source

impl IntoResponse for Response

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 !RefUnwindSafe for Response

impl Send for Response

impl Sync for Response

impl Unpin for Response

impl !UnwindSafe for Response

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

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

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

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

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

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> FutureExt for T

source

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

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

source

fn with_current_context(self) -> WithContext<Self>

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

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 for T where
U: From<T>,

const: unstable · 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> 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> Same<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

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

Struct poem::Response

Implementations

impl Response

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

pub fn builder() -> ResponseBuilder

pub fn status(&self) -> StatusCode

pub fn is_ok(&self) -> bool

pub fn is_success(&self) -> bool

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

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

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

pub fn headers(&self) -> &HeaderMap

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

pub fn header(&self, name: impl AsRef<str>) -> Option<&str>

pub fn version(&self) -> Version

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

pub fn extensions(&self) -> &Extensions

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

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

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

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

pub fn take_body(&mut self) -> Body

pub fn into_body(self) -> Body

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

Trait Implementations

impl Debug for Response

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

impl Default for Response

fn default() -> Response

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

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

impl From<Response<Body>> for Response

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

impl From<Response> for Response<Body>

fn from(resp: Response) -> Self

impl From<StatusCode> for Response

fn from(status: StatusCode) -> Self

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

fn from(body: T) -> Self

impl IntoResponse for Response

fn into_response(self) -> Response

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

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

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

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

Auto Trait Implementations

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

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

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

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

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

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for T

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

fn with_current_context(self) -> WithContext<Self>

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

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

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,