Struct gotham::test::AsyncTestRequestBuilder

source ·

pub struct AsyncTestRequestBuilder<'client, C: Connect> { /* private fields */ }

Expand description

Builder for a request made with an AsyncTestClient.

Once a request is fully built, it can be performed using the [perform] method.

Implementations§

source §

impl<'client, C: Connect + Clone + Send + Sync + 'static> AsyncTestRequestBuilder<'client, C>

source

pub async fn perform(self) -> Result<AsyncTestResponse>

Perform the built request.

source

pub fn mime(self, mime: Mime) -> Self

Convenience method to append a content-type header for the given MIME type.

source

pub fn body<B: Into<Body>>(self, body: B) -> Self

Set a Body for this request. See http::request::Builder::body. Other than the http::request::Builder::body it doesn’t finish building the request though, instead if called multiple times, only the last one is kept. Defaults to Body::empty if never called.

source

pub fn extension<T>(self, extension: T) -> Self
where T: Any + Send + Sync + 'static,

Add a custom value to this request. See http::request::Builder::extension

Add a header to this request. See http::request::Builder::header

source

pub fn method<M>(self, method: M) -> Self
where Method: TryFrom<M>, <Method as TryFrom<M>>::Error: Into<Error>,

Set the method of this request. See http::request::Builder::method

source

pub fn uri(self, uri: U) -> Self
where Uri: TryFrom, <Uri as TryFrom>::Error: Into<Error>,

Set the Uri of this request. See http::request::Builder::uri

source

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

Set the Version(HTTP Version) of this Request. http::request::Builder::version.

Methods from Deref<Target = Builder>§

source

pub fn method_ref(&self) -> Option<&Method>

Get the HTTP Method for this request.

By default this is GET. If builder has error, returns None.

§Examples


let mut req = Request::builder();
assert_eq!(req.method_ref(),Some(&Method::GET));

req = req.method("POST");
assert_eq!(req.method_ref(),Some(&Method::POST));

source

pub fn uri_ref(&self) -> Option<&Uri>

Get the URI for this request

By default this is /.

§Examples


let mut req = Request::builder();
assert_eq!(req.uri_ref().unwrap(), "/" );

req = req.uri("https://www.rust-lang.org/");
assert_eq!(req.uri_ref().unwrap(), "https://www.rust-lang.org/" );

source

pub fn version_ref(&self) -> Option<&Version>

Get the HTTP version for this request

By default this is HTTP/1.1.

§Examples


let mut req = Request::builder();
assert_eq!(req.version_ref().unwrap(), &Version::HTTP_11 );

req = req.version(Version::HTTP_2);
assert_eq!(req.version_ref().unwrap(), &Version::HTTP_2 );

source

pub fn headers_ref(&self) -> Option<&HeaderMap>

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

§Example

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

source

pub fn headers_mut(&mut self) -> Option<&mut HeaderMap>

Get headers on this request builder.

When builder has error returns None.

§Example

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

source

pub fn extensions_ref(&self) -> Option<&Extensions>

Get a reference to the extensions for this request builder.

If the builder has an error, this returns None.

§Example

let req = Request::builder().extension("My Extension").extension(5u32);
let extensions = req.extensions_ref().unwrap();
assert_eq!(extensions.get::<&'static str>(), Some(&"My Extension"));
assert_eq!(extensions.get::<u32>(), Some(&5u32));

source

pub fn extensions_mut(&mut self) -> Option<&mut Extensions>

Get a mutable reference to the extensions for this request builder.

If the builder has an error, this returns None.

§Example

let mut req = Request::builder().extension("My Extension");
let mut extensions = req.extensions_mut().unwrap();
assert_eq!(extensions.get::<&'static str>(), Some(&"My Extension"));
extensions.insert(5u32);
assert_eq!(extensions.get::<u32>(), Some(&5u32));