Skip to main content

Response

Struct Response 

Source
pub struct Response { /* private fields */ }
Expand description

Represents an HTTP response message.

Implementations§

Source§

impl Response

Source

pub fn new(status: StatusCode) -> Self

Create a new response with the provided status code and canonical reason.

Source

pub fn builder(status: StatusCode) -> ResponseBuilder

Construct a builder for the response.

Source

pub fn version(&self) -> HttpVersion

Return the HTTP version of the response.

Source

pub fn status(&self) -> StatusCode

Return the status code.

Source

pub fn reason_phrase(&self) -> &str

Access the reason phrase used for the status line.

Source

pub fn headers(&self) -> &Headers

Borrow header map immutably.

Source

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

Borrow header map mutably.

Source

pub fn body(&self) -> &ResponseBody

Borrow the body representation.

Source

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

Override the status code.

Source

pub fn take_body(&mut self) -> ResponseBody

Remove and return the body, leaving an empty placeholder behind.

Source

pub fn set_body(&mut self, body: ResponseBody)

Replace the body with the provided representation.

Source

pub fn set_body_bytes(&mut self, bytes: impl Into<Bytes>)

Convenience helper for replacing the body with fully buffered bytes.

Source

pub fn set_body_static(&mut self, bytes: &'static [u8])

Replace the body with a static byte slice without copying.

Source

pub fn set_body_text_static(&mut self, text: &'static str)

Replace the body with a static UTF-8 string without copying.

Source

pub fn strip_body_for_head(&mut self)

Prepare the response for a HEAD reply by stripping the body while preserving the advertised payload length when known.

Source

pub fn trailers(&self) -> Option<&Headers>

Borrow the trailers if present.

Source

pub fn set_trailers(&mut self, trailers: Headers)

Replace the trailers with the provided header set.

Source

pub fn take_trailers(&mut self) -> Option<Headers>

Remove any trailers from the response and return them.

Source

pub fn body_mut(&mut self) -> &mut ResponseBody

Borrow the body mutably.

Source

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

Override the HTTP version.

Source

pub fn set_reason(&mut self, reason: impl Into<String>)

Override the reason phrase.

Trait Implementations§

Source§

impl Debug for Response

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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

Source§

type Error = !

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