Struct Response

pub struct Response { /* private fields */ }

Each request ultimately ends in a Response that is served to the client and then discarded, like fallen flower petals. Together with Request and Responder it forms the holy trinity of R’s in Vial.

Rather than use the “Builder” pattern like more mature and better designed libraries, Vial’s Response lets you set properties either directly or using Builder-style methods:

vial::routes! {
    GET "/404" => |_| Response::from(404)
        .with_header("Content-Type", "text/plain")
        .with_body("404 Not Found");
}

It also defaults to text/html, so you need to use with_header() or header() to send plain text.

Implementations

impl Response

pub fn new() -> Response

Create a new, empty, 200 response - ready for HTML!

pub fn code(&self) -> usize

HTTP Status Code

pub fn content_type(&self) -> &str

Either the inferred or user-set Content-Type for this Response.

pub fn body(&self) -> &str

Response body.

pub fn headers(&self) -> &HashMap<String, String>

Take a peek at all the headers for this response.

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

Get an individual header. name is case insensitive.

pub fn set_header(&mut self, name: &str, value: &str)

Set an individual header.

pub fn from<T: Into<Response>>(from: T) -> Response

Convert into a Response.

pub fn from_asset(path: &str) -> Response

Create a response from an asset. See the asset module for more information on using assets.

pub fn from_reader(reader: Box<dyn Read>) -> Response

Create a response from a (boxed) io::Read.

pub fn from_file(path: &str) -> Response

Creates a response from a file on disk. TODO: Path?

pub fn from_error<E: Error>(err: E) -> Response

Creates a 500 response from an error, displaying it.

pub fn from_header(name: &str, value: &str) -> Response

Creates a new Response and sets the given header, in addition to the defaults.

pub fn from_body<S: AsRef<str>>(body: S) -> Response

Creates a new default Response with the given body.

pub fn from_text<S: AsRef<str>>(text: S) -> Response

Creates a new text/plain Response with the given body.

pub fn from_code(code: usize) -> Response

Creates a new response with the given HTTP Status Code.

pub fn with_code(self, code: usize) -> Response

Creates a new response with the given HTTP Status Code.

pub fn with_body<S: AsRef<str>>(self, body: S) -> Response

Body builder. Returns a Response with the given body.

pub fn with_text<S: AsRef<str>>(self, text: S) -> Response

Returns a text/plain Response with the given body.

pub fn with_reader(self, reader: Box<dyn Read>) -> Response

Returns a Response using the given reader for the body.

pub fn with_asset(self, path: &str) -> Response

Uses an asset for the given body and sets the Content-Type header based on the file’s extension.

See the asset module for more information on using assets.

pub fn with_file(self, path: &str) -> Response

Sets this Response’s body to the body of the given file and sets the Content-Type header based on the file’s extension.

pub fn with_error<E: Error>(self, err: E) -> Response

Sets the response code to 500 and the body to the error’s text.

pub fn with_header(self, key: &str, value: &str) -> Response

Returns a Response with the given header set to the value.

pub fn len(&self) -> usize

Length of the body.

pub fn is_empty(&self) -> bool

Is ths response empty?

pub fn redirect_to<U: AsRef<str>>(url: U) -> Response

Returns a 302 redirect to the given URL.

pub fn write<W: Write>(self, w: W) -> Result<()>

Writes this response to a stream.

Trait Implementations

impl Debug for Response

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

Formats the value using the given formatter.

impl Default for Response

fn default() -> Response

Returns the “default value” for a type.

impl Display for Response

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

Formats the value using the given formatter.

impl From<&String> for Response

fn from(s: &String) -> Response

Converts to this type from the input type.

impl From<&str> for Response

fn from(s: &str) -> Response

Converts to this type from the input type.

impl From<Cow<'_, [u8]>> for Response

fn from(i: Cow<'_, [u8]>) -> Response

Converts to this type from the input type.

impl From<String> for Response

fn from(body: String) -> Response

Converts to this type from the input type.

impl From<usize> for Response

fn from(i: usize) -> Response

Converts to this type from the input type.

impl PartialEq for Response

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Responder for Response

fn to_response(self) -> Response

Consume this object and return a Response representing it.