Struct sharp_pencil::wrappers::Response

pub struct Response {
    pub status_code: u16,
    pub headers: Headers,
    pub body: Option<Box<dyn BodyWrite>>,
}

Response type. It is just one container with a couple of parameters (headers, body, status code etc).

Fields

status_code: u16

The HTTP Status code number

headers: Headers

body: Option<Box<dyn BodyWrite>>

Implementations

impl Response

pub fn new<T: 'static + BodyWrite>(body: T) -> Response

Create a Response. By default, the status code is 200 and content type is "text/html; charset=UTF-8". Remember to set content length if necessary. Mostly you should just get a response that is converted from other types, which set the content length automatically. For example:

// Content length is set automatically
let response = Response::from("Hello");

pub fn new_empty() -> Response

Create an empty response without body.

pub fn status_name(&self) -> &str

Get status name.

pub fn content_type(&self) -> Option<&ContentType>

Returns the response content type if available.

pub fn set_content_type(&mut self, mimetype: &str)

Set response content type. If the mimetype passed is a mimetype starting with text/ or something that needs a charset, the charset(UTF-8) parameter is appended to it.

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

Returns the response content length if available.

pub fn set_content_length(&mut self, value: usize)

Set content length.

pub fn set_cookie(&mut self, cookie: SetCookie)

Sets cookie.

Trait Implementations

impl Debug for Response

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

Formats the value using the given formatter.

impl<'a> From<&'a [u8]> for Response

fn from(bytes: &'a [u8]) -> Response

Convert to response body. The content length is set automatically.

impl<'a> From<&'a str> for Response

fn from(s: &'a str) -> Response

Convert to response body. The content length is set automatically.

impl From<File> for Response

fn from(f: File) -> Response

Convert to response body. The content length is set automatically if file size is available from metadata.

impl From<String> for Response

fn from(s: String) -> Response

Convert a new string to response body. The content length is set automatically.

impl From<Vec<u8>> for Response

fn from(bytes: Vec<u8>) -> Response

Convert to response body. The content length is set automatically.