Struct Response

pub struct Response<R> { /* private fields */ }

Object representing an HTTP response whose purpose is to be given to a Request.

Some headers cannot be changed. Trying to define the value of one of these will have no effect:

• Connection
• Trailer
• Transfer-Encoding
• Upgrade

Some headers have special behaviors:

• Content-Encoding: If you define this header, the library will assume that the data from the Read object has the specified encoding and will just pass-through.

• Content-Length: The length of the data should be set manually using the Reponse object’s API. Attempting to set the value of this header will be equivalent to modifying the size of the data but the header itself may not be present in the final result.

• Content-Type: You may only set this header to one value at a time. If you try to set it more than once, the existing value will be overwritten. This behavior differs from the default for most headers, which is to allow them to be set multiple times in the same response.

Implementations

impl<R> Response<R>

where R: Read,

pub fn new( status_code: StatusCode, headers: Vec<Header>, data: R, data_length: Option<usize>, additional_headers: Option<Receiver<Header>>, ) -> Response<R>

Creates a new Response object.

The additional_headers argument is a receiver that may provide headers even after the response has been sent.

All the other arguments are straight-forward.

pub fn with_chunked_threshold(self, length: usize) -> Response<R>

Set a threshold for Content-Length where we chose chunked transfer. Notice that chunked transfer might happen regardless of this threshold, for instance when the request headers indicate it is wanted or when there is no Content-Length.

pub fn into_reader(self) -> R

Convert the response into the underlying Read type.

This is mainly useful for testing as it must consume the Response.

pub fn chunked_threshold(&self) -> usize

The current Content-Length threshold for switching over to chunked transfer. The default is 32768 bytes. Notice that chunked transfer is mutually exclusive with sending a Content-Length header as per the HTTP spec.

pub fn add_header<H>(&mut self, header: H)

where H: Into<Header>,

Adds a header to the list. Does all the checks.

pub fn with_header<H>(self, header: H) -> Response<R>

where H: Into<Header>,

Returns the same request, but with an additional header.

Some headers cannot be modified and some other have a special behavior. See the documentation above.

pub fn with_status_code<S>(self, code: S) -> Response<R>

where S: Into<StatusCode>,

Returns the same request, but with a different status code.

pub fn with_data<S>(self, reader: S, data_length: Option<usize>) -> Response<S>

where S: Read,

Returns the same request, but with different data.

pub fn raw_print<W: Write>( self, writer: W, http_version: HTTPVersion, request_headers: &[Header], do_not_send_body: bool, upgrade: Option<&str>, ) -> IoResult<()>

Prints the HTTP response to a writer.

This function is the one used to send the response to the client’s socket. Therefore you shouldn’t expect anything pretty-printed or even readable.

The HTTP version and headers passed as arguments are used to decide which features (most notably, encoding) to use.

Note: does not flush the writer.

pub fn status_code(&self) -> StatusCode

Retrieves the current value of the Response status code

pub fn data_length(&self) -> Option<usize>

Retrieves the current value of the Response data length

pub fn headers(&self) -> &[Header]

Retrieves the current list of Response headers

impl<R> Response<R>

where R: Read + Send + 'static,

pub fn boxed(self) -> ResponseBox

Turns this response into a Response<Box<Read + Send>>.

impl Response<File>

pub fn from_file(file: File) -> Response<File>

Builds a new Response from a File.

The Content-Type will not be automatically detected, you must set it yourself.

impl Response<Cursor<Vec<u8>>>

pub fn from_data<D>(data: D) -> Response<Cursor<Vec<u8>>>

where D: Into<Vec<u8>>,

pub fn from_string<S>(data: S) -> Response<Cursor<Vec<u8>>>

where S: Into<String>,

impl Response<Empty>

pub fn empty<S>(status_code: S) -> Response<Empty>

where S: Into<StatusCode>,

Builds an empty Response with the given status code.

pub fn new_empty(status_code: StatusCode) -> Response<Empty>

DEPRECATED. Use empty instead.

Trait Implementations

impl Clone for Response<Empty>

fn clone(&self) -> Response<Empty>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.