Skip to main content

RequestBuilder

Struct RequestBuilder 

Source
pub struct RequestBuilder { /* private fields */ }
Expand description

A fluent Request builder.

let request = Request::builder()
    .method(Method::POST)
    .uri("/posts?draft=1")
    .json(&serde_json::json!({ "title": "Hello" }))
    .build();

assert_eq!(request.input("title").as_deref(), Some("Hello"));
assert_eq!(request.input("draft").as_deref(), Some("1"));

Implementations§

Source§

impl RequestBuilder

Source

pub fn new() -> Self

A GET / request with no headers or body.

Source

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

Set the method.

Source

pub fn uri(self, uri: impl Into<String>) -> Self

Set the URI (path and optional query string).

Source

pub fn header(self, name: &str, value: &str) -> Self

Add a header. Ignored if the name or value is not a legal header.

Source

pub fn body(self, body: impl Into<Bytes>) -> Self

Set a raw body.

Source

pub fn json(self, value: &impl Serialize) -> Self

Set a JSON body and the matching Content-Type.

Source

pub fn form(self, pairs: &[(&str, &str)]) -> Self

Set a urlencoded form body and the matching Content-Type.

Source

pub fn route_param( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Pre-set a route parameter, as the router would after matching.

Source

pub fn build(self) -> Request

Build the request.

Trait Implementations§

Source§

impl Debug for RequestBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RequestBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.