Struct anneal::RequestBuilder

pub struct RequestBuilder { /* fields omitted */ }

Methods

impl RequestBuilder

pub fn new<U: IntoUrl>(
    method: Method,
    url: U
) -> Result<RequestBuilder, ParseError>

Create a new request builder with the given method and url

An error will be returned if the url fails to parse

pub fn get<U: IntoUrl>(url: U) -> Result<RequestBuilder, ParseError>

Shorthand for RequestBuilder::new(Method::Get, url)

pub fn post<U: IntoUrl>(url: U) -> Result<RequestBuilder, ParseError>

Shorthand for RequestBuilder::new(Method::Post, url)

pub fn options<U: IntoUrl>(url: U) -> Result<RequestBuilder, ParseError>

Shorthand for RequestBuilder::new(Method::Options, url)

pub fn put<U: IntoUrl>(url: U) -> Result<RequestBuilder, ParseError>

Shorthand for RequestBuilder::new(Method::Put, url)

pub fn delete<U: IntoUrl>(url: U) -> Result<RequestBuilder, ParseError>

Shorthand for RequestBuilder::new(Method::Delete, url)

pub fn head<U: IntoUrl>(url: U) -> Result<RequestBuilder, ParseError>

Shorthand for RequestBuilder::new(Method::Head, url)

pub fn trace<U: IntoUrl>(url: U) -> Result<RequestBuilder, ParseError>

Shorthand for RequestBuilder::new(Method::Trace, url)

pub fn connect<U: IntoUrl>(url: U) -> Result<RequestBuilder, ParseError>

Shorthand for RequestBuilder::new(Method::Connect, url)

pub fn patch<U: IntoUrl>(url: U) -> Result<RequestBuilder, ParseError>

Shorthand for RequestBuilder::new(Method::Patch, url)

pub fn default_post() -> Self

Builds a POST request to http://127.0.0.1:8080/

pub fn set_header<H: Header + HeaderFormat>(&mut self, header: H) -> &mut Self

Set an individual header

pub fn set_headers(&mut self, headers: Headers) -> &mut Self

Replace the headers with a new Headers struct

pub fn set_url<U: IntoUrl>(&mut self, url: U) -> Result<&mut Self, ParseError>

Change the destination url of this request

pub fn set_method(&mut self, method: Method) -> &mut Self

Change this request's method

pub fn set_bytes(&mut self, body: Vec<u8>) -> &mut Self

Set the body of the request to the provided vec

pub fn set_string(&mut self, body: &str) -> &mut Self

Set the body of the request to the provided string

pub fn add_middleware<B: BeforeMiddleware + 'static>(
    &mut self,
    middleware: B
) -> &mut Self

Add BeforeMiddleware to be run before the main handler

This adds middleware after all that is currently on the chain. If the middleware in this chain fails while building a request the request will panic.

pub fn set_chain(&mut self, chain: Vec<Box<dyn BeforeMiddleware>>) -> &mut Self

Set the middleware chain to be run before the main handler

pub fn set_cookies(&mut self, cookies: &CookieJar) -> &mut Self

Set the Cookie header of the request

pub fn set_json<T: Serialize>(&mut self, json: &T) -> &mut Self

Set the main body of the request to contain serialized json

This also sets the Content-Type header to application/json

pub fn request<T, H: FnOnce(Request) -> T>(&self, handler: H) -> T

Generate a request and hand it off to some handler function

This will panic if any of the middleware in the before chain fails

The return value of the handler function will be return value of this function

pub fn request_response<H: FnOnce(Request) -> IronResult<Response>>(
    &self,
    handler: H
) -> IronResult<ResponseExamine>

Generate a request and hand it off to a handler function, mapping the response into a ResponseExamine for easier checking

Trait Implementations

impl Default for RequestBuilder

Builds a GET request to http://127.0.0.1:8080/

fn default() -> Self

Returns the "default value" for a type.