Struct zng_task::http::Client

pub struct Client { /* private fields */ }

HTTP client.

An HTTP client acts as a session for executing one of more HTTP requests.

Implementations

impl Client

pub fn new() -> Self

New client with default config.

This enables cookies, sets the redirect_policy with a limit of up-to 20 redirects and auto_referer, sets the connect_timeout to 90 seconds and enables metrics.

pub fn builder() -> ClientBuilder

Start a new ClientBuilder for creating a custom client.

pub fn cookie_jar(&self) -> Option<&CookieJar>

Gets the configured cookie-jar for this client, if cookies are enabled.

pub async fn get(&self, uri: impl TryUri) -> Result<Response, Error>

Send a GET request to the uri.

pub async fn get_txt(&self, uri: impl TryUri) -> Result<Txt, Error>

Send a GET request to the uri and read the response as a string.

pub async fn get_bytes(&self, uri: impl TryUri) -> Result<Vec<u8>, Error>

Send a GET request to the uri and read the response as raw bytes.

pub async fn get_json<O>(&self, uri: impl TryUri) -> Result<O, Box<dyn Error>>

where O: DeserializeOwned + Unpin,

Send a GET request to the uri and de-serializes the response.

pub async fn head(&self, uri: impl TryUri) -> Result<Response, Error>

Send a HEAD request to the uri.

pub async fn put( &self, uri: impl TryUri, body: impl TryBody, ) -> Result<Response, Error>

Send a PUT request to the uri with a given request body.

pub async fn post( &self, uri: impl TryUri, body: impl TryBody, ) -> Result<Response, Error>

Send a POST request to the uri with a given request body.

pub async fn delete(&self, uri: impl TryUri) -> Result<Response, Error>

Send a DELETE request to the uri.

pub async fn send(&self, request: Request) -> Result<Response, Error>

Send a custom Request.

Cache

If the client has a cache and the request uses the GET method the result will be cached according with the cache_mode selected for the request.

pub fn cache(&self) -> Option<&dyn CacheDb>

Reference the cache used in this client.

pub fn cache_mode(&self, request: &Request) -> CacheMode

Returns the CacheMode that is used in this client if the request is made.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.

impl From<Client> for HttpClient

fn from(c: Client) -> Self

Converts to this type from the input type.

impl From<HttpClient> for Client

fn from(client: HttpClient) -> Self

Converts to this type from the input type.