Struct hyper::server::response::Response

pub struct Response<'a, W: Any = Fresh> {
    pub version: HttpVersion,
    // some fields omitted
}

The outgoing half for a Tcp connection, created by a Server and given to a Handler.

The default StatusCode for a Response is 200 OK.

There is a Drop implementation for Response that will automatically write the head and flush the body, if the handler has not already done so, so that the server doesn't accidentally leave dangling requests.

Fields

version: HttpVersion

The HTTP version of this response.

Methods

impl<'a, W: Any> Response<'a, W>

pub fn status(&self) -> StatusCode

The status of this response.

pub fn headers(&self) -> &Headers

The headers of this response.

Important traits for Response<'a, Streaming>

impl<'a> Write for Response<'a, Streaming>

pub fn construct(
    version: HttpVersion,
    body: HttpWriter<&'a mut (dyn Write + 'a)>,
    status: StatusCode,
    headers: &'a mut Headers
) -> Response<'a, Fresh>

Construct a Response from its constituent parts.

pub fn deconstruct(
    self
) -> (HttpVersion, HttpWriter<&'a mut (dyn Write + 'a)>, StatusCode, &'a mut Headers)

Deconstruct this Response into its constituent parts.

impl<'a> Response<'a, Fresh>

Important traits for Response<'a, Streaming>

impl<'a> Write for Response<'a, Streaming>

pub fn new(
    stream: &'a mut (dyn Write + 'a),
    headers: &'a mut Headers
) -> Response<'a, Fresh>

Creates a new Response that can be used to write to a network stream.

pub fn send(self, body: &[u8]) -> Result<()>

Writes the body and ends the response.

This is a shortcut method for when you have a response with a fixed size, and would only need a single write call normally.

Example

fn handler(res: Response) {
    res.send(b"Hello World!").unwrap();
}

The above is the same, but shorter, than the longer:

use std::io::Write;
use hyper::header::ContentLength;
fn handler(mut res: Response) {
    let body = b"Hello World!";
    res.headers_mut().set(ContentLength(body.len() as u64));
    let mut res = res.start().unwrap();
    res.write_all(body).unwrap();
}

pub fn start(self) -> Result<Response<'a, Streaming>>

Consume this Response, writing the Headers and Status and creating a Response

pub fn status_mut(&mut self) -> &mut StatusCode

Get a mutable reference to the status.

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

Get a mutable reference to the Headers.

impl<'a> Response<'a, Streaming>

pub fn end(self) -> Result<()>

Flushes all writing of a response to the client.

Trait Implementations

impl<'a, T: Any> Drop for Response<'a, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, W: Debug + Any> Debug for Response<'a, W>

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

Formats the value using the given formatter.

impl<'a> Write for Response<'a, Streaming>

fn write(&mut self, msg: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoVec]) -> Result<usize, Error>

🔬 This is a nightly-only experimental API. (iovec)

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.