RequestBuilder

Struct RequestBuilder 

Source
pub struct RequestBuilder<B = Bytes> { /* private fields */ }
Expand description

Builder for constructing Request instances.

Implementations§

Source§

impl<B> RequestBuilder<B>

Source

pub fn new(method: Method, url: Url) -> RequestBuilder<B>

Creates a new builder.

Source

pub fn header( self, name: impl Into<String>, value: impl Into<String>, ) -> RequestBuilder<B>

Sets a header.

Source

pub fn headers( self, headers: impl IntoIterator<Item = (String, String)>, ) -> RequestBuilder<B>

Sets multiple headers.

Source

pub fn query(self, name: &str, value: &str) -> RequestBuilder<B>

Appends a query parameter to the URL.

Source

pub fn query_pairs( self, pairs: impl IntoIterator<Item = (String, String)>, ) -> RequestBuilder<B>

Appends multiple query parameters to the URL.

Source

pub fn body(self, body: B) -> RequestBuilder<B>

Sets the request body.

Source

pub fn extension<T>(self, value: T) -> RequestBuilder<B>
where T: Clone + Send + Sync + 'static,

Insert a typed extension value.

Extensions allow middleware to attach arbitrary typed data to requests.

Source

pub fn extensions(self, extensions: Extensions) -> RequestBuilder<B>

Set extensions from an existing Extensions container.

This replaces any previously set extensions.

Source

pub fn build(self) -> Request<B>

Builds the Request.

Source§

impl RequestBuilder

Source

pub fn json<T>(self, value: &T) -> Result<RequestBuilder, Error>
where T: Serialize,

Set a JSON body.

§Errors

Returns an error if serialization fails.

Source

pub fn form<T>(self, value: &T) -> Result<RequestBuilder, Error>
where T: Serialize,

Set a form-urlencoded body.

§Errors

Returns an error if serialization fails.

Trait Implementations§

Source§

impl<B> Clone for RequestBuilder<B>
where B: Clone,

Source§

fn clone(&self) -> RequestBuilder<B>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<B> Debug for RequestBuilder<B>
where B: Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<B> Freeze for RequestBuilder<B>
where B: Freeze,

§

impl<B = Bytes> !RefUnwindSafe for RequestBuilder<B>

§

impl<B> Send for RequestBuilder<B>
where B: Send,

§

impl<B> Sync for RequestBuilder<B>
where B: Sync,

§

impl<B> Unpin for RequestBuilder<B>
where B: Unpin,

§

impl<B = Bytes> !UnwindSafe for RequestBuilder<B>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more