Skip to main content

Request

Struct Request 

Source
pub struct Request {
    pub method: Method,
    pub path: String,
    pub headers: HashMap<String, String>,
    pub body: Option<RequestBody>,
    pub query: Option<HashMap<String, String>>,
    pub auth: Option<Auth>,
}
Expand description

HTTP request builder.

Fields§

§method: Method

HTTP method (GET, POST, etc.)

§path: String

Request path (absolute or relative to base_url)

§headers: HashMap<String, String>

Request headers

§body: Option<RequestBody>

Request body (JSON or bytes)

§query: Option<HashMap<String, String>>

Query parameters

§auth: Option<Auth>

Authentication override (if None, use client default)

Implementations§

Source§

impl Request

Source

pub fn get(path: impl Into<String>) -> Self

Creates a new GET request.

Source

pub fn post(path: impl Into<String>) -> Self

Creates a new POST request.

Source

pub fn put(path: impl Into<String>) -> Self

Creates a new PUT request.

Source

pub fn patch(path: impl Into<String>) -> Self

Creates a new PATCH request.

Source

pub fn delete(path: impl Into<String>) -> Self

Creates a new DELETE request.

Source

pub fn head(path: impl Into<String>) -> Self

Creates a new HEAD request.

Source

pub fn new(method: Method, path: impl Into<String>) -> Self

Creates a new request with the given method and path.

Source

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

Sets the request path.

Source

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

Adds a header.

Source

pub fn headers(self, headers: HashMap<String, String>) -> Self

Sets multiple headers.

Source

pub fn body(self, body: RequestBody) -> Self

Sets the request body.

Source

pub fn json_body<T: Serialize>(self, value: &T) -> Result<Self, Error>

Sets the request body from a JSON-serializable value.

Source

pub fn query(self, params: HashMap<String, String>) -> Self

Sets query parameters.

Source

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

Adds a query parameter.

Source

pub fn auth(self, auth: Auth) -> Self

Sets authentication for this request (overrides client default).

Source

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

Sets Bearer token authentication for this request.

Source

pub fn basic_auth( self, username: impl Into<String>, password: impl Into<String>, ) -> Self

Sets Basic authentication for this request.

Trait Implementations§

Source§

impl Clone for Request

Source§

fn clone(&self) -> Request

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Request

Source§

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

Formats the value using the given formatter. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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