Struct iron::response::HttpResponse

pub struct HttpResponse<'a, W = Fresh> where
    W: Any,  {
    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> Response<'a, W> where
    W: Any, 

fn status(&self) -> StatusCode

The status of this response.

fn headers(&self) -> &Headers

The headers of this response.

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

Construct a Response from its constituent parts.

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

Deconstruct this Response into its constituent parts.

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

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

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

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

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();
}

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

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

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

Get a mutable reference to the status.

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

Get a mutable reference to the Headers.

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

fn end(self) -> Result<(), Error>

Flushes all writing of a response to the client.

Trait Implementations

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

fn drop(&mut self)

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

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

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

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

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

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

Attempts to write an entire buffer into this write.

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.

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

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.