Skip to main content

Client

Struct Client 

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

HTTP client for making typed requests against a Target server.

A Client is created in one of three modes depending on which send variants you need:

Constructorsend() (async)send_sync() (blocking)Safe in async context
Client::new_async
Client::new_sync
Client::new✗ — panics if called inside a tokio runtime

reqwest::blocking::Client internally creates its own single-threaded tokio runtime. If you call Client::new() (or Client::new_sync()) from within an existing async context (e.g. inside #[tokio::main]) it will panic. Use Client::new_async() when your program is async-first and only call Client::new_sync() / Client::new() before entering any async runtime.

§Example

// Async-only client — safe inside #[tokio::main]
let client = Client::new_async(Target::Localhost(8080));

let items: Vec<Item> = client.get("/items").send().await?;
let created: Item = client.post("/items").json(NewItem { name: "w".into() }).send().await?;

Implementations§

Source§

impl Client

Source

pub fn new_async(target: Target) -> Self

Creates an async-only client. Safe to call from any context, including inside #[tokio::main]. Calling .send_sync() on builders from this client will panic.

Source

pub fn new_sync(target: Target) -> Self

Creates a sync-only client. Must not be called from within an async context (inside #[tokio::main] or similar) — doing so panics. Calling .send() on builders from this client will panic with a message pointing to Client::new_async.

§Panics

Panics at construction time if called inside a tokio runtime (same restriction as reqwest::blocking::Client). Prefer Client::new_async for async contexts.

Source

pub fn new(target: Target) -> Self

Creates a client supporting both async and blocking sends.

§Panics

Panics immediately if called from within an async context (e.g. inside #[tokio::main], tokio::spawn, or any .await call chain). This happens because reqwest::blocking::Client creates its own internal tokio runtime, and Rust/tokio forbids nesting two runtimes in the same thread.

If you are in an async context, use Client::new_async instead. If you only need blocking calls, use Client::new_sync before entering any runtime.

§Example
// Correct — called from synchronous main before any async runtime starts
fn main() {
    let client = Client::new(Target::Localhost(8080));
    // ... use client.send_sync() and client.send() via manual runtime
}

// WRONG — will panic at runtime:
// #[tokio::main]
// async fn main() { let client = Client::new(...); }  // panics!
Source

pub fn base_url(&self) -> String

Returns the base URL derived from the configured Target.

Source

pub fn get(&self, endpoint: impl Into<String>) -> RequestBuilder<'_>

Starts a GET request builder for endpoint.

Source

pub fn post(&self, endpoint: impl Into<String>) -> RequestBuilder<'_>

Starts a POST request builder for endpoint.

Source

pub fn put(&self, endpoint: impl Into<String>) -> RequestBuilder<'_>

Starts a PUT request builder for endpoint.

Source

pub fn delete(&self, endpoint: impl Into<String>) -> RequestBuilder<'_>

Starts a DELETE request builder for endpoint.

Source

pub fn patch(&self, endpoint: impl Into<String>) -> RequestBuilder<'_>

Starts a PATCH request builder for endpoint.

Source

pub fn head(&self, endpoint: impl Into<String>) -> RequestBuilder<'_>

Starts a HEAD request builder for endpoint.

Source

pub fn options(&self, endpoint: impl Into<String>) -> RequestBuilder<'_>

Starts an OPTIONS request builder for endpoint.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

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

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> 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: 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: 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> 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