Struct surf::Client

pub struct Client<C: HttpClient> { /* fields omitted */ }

An HTTP client, capable of creating new Requests.

Examples

let client = surf::Client::new();
let req1 = client.get("https://httpbin.org/get").recv_string();
let req2 = client.get("https://httpbin.org/get").recv_string();
let (str1, str2) = futures::future::try_join(req1, req2).await?;

Methods

impl Client<NativeClient>

pub fn new() -> Self

Create a new instance.

Examples

let client = surf::Client::new();

impl<C: HttpClient> Client<C>

Important traits for Request<C>

impl<C: HttpClient> Future for Request<C> type Output = Result<Response, Exception>;

pub fn get(&self, uri: impl AsRef<str>) -> Request<C>

Perform an HTTP GET request using the Client connection.

Panics

This will panic if a malformed URL is passed.

Errors

Returns errors from the middleware, http backend, and network sockets.

Examples

let client = surf::Client::new();
let string = client.get("https://httpbin.org/get").recv_string().await?;

Important traits for Request<C>

impl<C: HttpClient> Future for Request<C> type Output = Result<Response, Exception>;

pub fn head(&self, uri: impl AsRef<str>) -> Request<C>

Perform an HTTP HEAD request using the Client connection.

Panics

This will panic if a malformed URL is passed.

Errors

Returns errors from the middleware, http backend, and network sockets.

Examples

let client = surf::Client::new();
let string = client.head("https://httpbin.org/head").recv_string().await?;

Important traits for Request<C>

impl<C: HttpClient> Future for Request<C> type Output = Result<Response, Exception>;

pub fn post(&self, uri: impl AsRef<str>) -> Request<C>

Perform an HTTP POST request using the Client connection.

Panics

This will panic if a malformed URL is passed.

Errors

Returns errors from the middleware, http backend, and network sockets.

Examples

let client = surf::Client::new();
let string = client.post("https://httpbin.org/post").recv_string().await?;

Important traits for Request<C>

impl<C: HttpClient> Future for Request<C> type Output = Result<Response, Exception>;

pub fn put(&self, uri: impl AsRef<str>) -> Request<C>

Perform an HTTP PUT request using the Client connection.

Panics

This will panic if a malformed URL is passed.

Errors

Returns errors from the middleware, http backend, and network sockets.

Examples

let client = surf::Client::new();
let string = client.put("https://httpbin.org/put").recv_string().await?;

Important traits for Request<C>

impl<C: HttpClient> Future for Request<C> type Output = Result<Response, Exception>;

pub fn delete(&self, uri: impl AsRef<str>) -> Request<C>

Perform an HTTP DELETE request using the Client connection.

Panics

This will panic if a malformed URL is passed.

Errors

Returns errors from the middleware, http backend, and network sockets.

Examples

let client = surf::Client::new();
let string = client.delete("https://httpbin.org/delete").recv_string().await?;

Important traits for Request<C>

impl<C: HttpClient> Future for Request<C> type Output = Result<Response, Exception>;

pub fn connect(&self, uri: impl AsRef<str>) -> Request<C>

Perform an HTTP CONNECT request using the Client connection.

Panics

This will panic if a malformed URL is passed.

Errors

Returns errors from the middleware, http backend, and network sockets.

Examples

let client = surf::Client::new();
let string = client.connect("https://httpbin.org/connect").recv_string().await?;

Important traits for Request<C>

impl<C: HttpClient> Future for Request<C> type Output = Result<Response, Exception>;

pub fn options(&self, uri: impl AsRef<str>) -> Request<C>

Perform an HTTP OPTIONS request using the Client connection.

Panics

This will panic if a malformed URL is passed.

Errors

Returns errors from the middleware, http backend, and network sockets.

Examples

let client = surf::Client::new();
let string = client.options("https://httpbin.org/options").recv_string().await?;

Important traits for Request<C>

impl<C: HttpClient> Future for Request<C> type Output = Result<Response, Exception>;

pub fn trace(&self, uri: impl AsRef<str>) -> Request<C>

Perform an HTTP TRACE request using the Client connection.

Panics

This will panic if a malformed URL is passed.

Errors

Returns errors from the middleware, http backend, and network sockets.

Examples

let client = surf::Client::new();
let string = client.trace("https://httpbin.org/trace").recv_string().await?;

Important traits for Request<C>

impl<C: HttpClient> Future for Request<C> type Output = Result<Response, Exception>;

pub fn patch(&self, uri: impl AsRef<str>) -> Request<C>

Perform an HTTP PATCH request using the Client connection.

Panics

This will panic if a malformed URL is passed.

Errors

Returns errors from the middleware, http backend, and network sockets.

Examples

let client = surf::Client::new();
let string = client.patch("https://httpbin.org/patch").recv_string().await?;

Trait Implementations

impl<C: Default + HttpClient> Default for Client<C>

fn default() -> Client<C>

Returns the "default value" for a type.

impl<C: Debug + HttpClient> Debug for Client<C>

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

Formats the value using the given formatter.