[−][src]Struct saphir::response::Builder

pub struct Builder { /* fields omitted */ }

Struct used to conveniently build a response

Implementations

impl Builder[src]

pub fn new() -> Self[src]

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


let response = Builder::new()
    .status(200)
    .build()
    .unwrap();

pub fn status<T>(self, status: T) -> Builder where
    StatusCode: TryFrom<T>,
    <StatusCode as TryFrom<T>>::Error: Into<Error>, [src]

Set the HTTP status for this response.

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

By default this is 200.


let response = Builder::new()
    .status(200)
    .build()
    .unwrap();

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

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


let response = Builder::new()
    .version(Version::HTTP_2)
    .build()
    .unwrap();

pub fn header<K, V>(self, key: K, value: V) -> Builder where
    HeaderName: TryFrom<K>,
    <HeaderName as TryFrom<K>>::Error: Into<Error>,
    HeaderValue: TryFrom<V>,
    <HeaderValue as TryFrom<V>>::Error: Into<Error>, [src]

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.


let response = Builder::new()
    .header("Content-Type", "text/html")
    .header("X-Custom-Foo", "bar")
    .header("content-length", 0)
    .build()
    .unwrap();

pub fn headers_ref(&self) -> Option<&HeaderMap<HeaderValue>>[src]

Get header on this response builder.

When builder has error returns None.

let res = Builder::new()
    .header("Accept", "text/html")
    .header("X-Custom-Foo", "bar");
let headers = res.headers_ref().unwrap();
assert_eq!( headers["Accept"], "text/html" );
assert_eq!( headers["X-Custom-Foo"], "bar" );

pub fn headers_mut(&mut self) -> Option<&mut HeaderMap<HeaderValue>>[src]

Get header on this response builder. when builder has error returns None

let mut res = Builder::new();
{
  let headers = res.headers_mut().unwrap();
  headers.insert("Accept", HeaderValue::from_static("text/html"));
  headers.insert("X-Custom-Foo", HeaderValue::from_static("bar"));
}
let headers = res.headers_ref().unwrap();
assert_eq!( headers["Accept"], "text/html" );
assert_eq!( headers["X-Custom-Foo"], "bar" );

pub fn extension<T>(self, extension: T) -> Builder where
    T: Any + Send + Sync + 'static, [src]

Adds an extension to this builder


let response = Builder::new()
    .extension("My Extension")
    .build()
    .unwrap();

assert_eq!(response.extensions().get::<&'static str>(),
           Some(&"My Extension"));

pub fn cookie(self, cookie: Cookie<'static>) -> Builder[src]

Adds an extension to this builder


let cookie = Cookie::new("MyCookie", "MyCookieValue");

let response = Builder::new()
    .cookie(cookie)
    .build()
    .unwrap();

assert_eq!(response.cookies().get("MyCookie").map(|c| c.value()), Some("MyCookieValue"))

pub fn cookies_mut(&mut self) -> &mut CookieJar[src]

pub fn body<B: 'static + Into<RawBody> + Send>(self, body: B) -> Builder[src]

pub fn build(self) -> Result<Response<Body>, SaphirError>[src]

Finish the builder into Response

Trait Implementations

impl Default for Builder[src]

impl Responder for Builder[src]

Auto Trait Implementations

impl !RefUnwindSafe for Builder

impl Send for Builder

impl !Sync for Builder

impl Unpin for Builder

impl !UnwindSafe for Builder

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.