Struct tauri::http::ResponseBuilder

pub struct ResponseBuilder { /* private fields */ }

An HTTP response builder

This type can be used to construct an instance of Response through a builder-like pattern.

Implementations

impl Builder

pub fn new() -> Builder

Creates a new default instance of Builder to construct either a Head or a Response.

Examples

let response = ResponseBuilder::new()
    .status(200)
    .mimetype("text/html")
    .body(Vec::new())
    .unwrap();

pub fn mimetype(self, mimetype: &str) -> Builder

Set the HTTP mimetype for this response.

pub fn status<T>(self, status: T) -> Builderwhere
    StatusCode: TryFrom<T>,
    <StatusCode as TryFrom<T>>::Error: Into<Error>,

Set the HTTP status for this response.

pub fn version(self, version: Version) -> Builder

Set the HTTP version for this response.

This function will configure the HTTP version of the Response that will be returned from Builder::build.

By default this is HTTP/1.1

pub fn header<K, V>(self, key: K, value: V) -> Builderwhere
    HeaderName: TryFrom<K>,
    <HeaderName as TryFrom<K>>::Error: Into<Error>,
    HeaderValue: TryFrom<V>,
    <HeaderValue as TryFrom<V>>::Error: Into<Error>,

Appends a header to this response builder.

This function will append the provided key/value as a header to the internal HeaderMap being constructed. Essentially this is equivalent to calling HeaderMap::append.

pub fn body(
    self,
    body: Vec<u8, Global>
) -> Result<Response, Box<dyn Error + 'static, Global>>

“Consumes” this builder, using the provided body to return a constructed Response.

Errors

This function may return an error if any previously configured argument failed to parse or get converted to the internal representation. For example if an invalid head was specified via header("Foo", "Bar\r\n") the error will be returned when this function is called rather than when header was called.

Examples

let response = ResponseBuilder::new()
    .mimetype("text/html")
    .body(Vec::new())
    .unwrap();

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.