Struct Client 

pub struct Client { /* private fields */ }

Defaults shared by several requests: headers, timeouts and redirect handling. Requests built from a client start with these values and can override each of them.

use std::time::Duration;

use curlite::{HeaderValue, header::AUTHORIZATION};

let api = curlite::Client::new()
    .header(AUTHORIZATION, HeaderValue::from_static("Bearer secret"))
    .timeout(Duration::from_secs(5));
let me = api.get("https://example.com/me").send()?;
let them = api.get("https://example.com/them").send()?;

A client holds configuration only. The libcurl handle, and with it the connection cache, belongs to the thread; see Request::send.

Implementations

impl Client

pub fn new() -> Self

A client with the same defaults as the free functions.

pub fn header(self, name: HeaderName, value: HeaderValue) -> Self

A header sent with every request, unless the request sets the same name itself. Takes parsed types so that building a client cannot fail; Request::header accepts strings.

pub fn timeout(self, timeout: Duration) -> Self

See Request::timeout.

pub fn connect_timeout(self, timeout: Duration) -> Self

See Request::connect_timeout.

pub fn stall_timeout(self, timeout: Duration) -> Self

See Request::stall_timeout.

pub fn follow_redirects(self, follow: bool) -> Self

See Request::follow_redirects.

pub fn max_redirects(self, max: u32) -> Self

See Request::max_redirects.

pub fn http_version(self, version: HttpVersion) -> Self

See Request::http_version.

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

See Request::proxy.

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

See Request::unix_socket.

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

See Request::ca_bundle.

pub fn danger_accept_invalid_certs(self) -> Self

See Request::danger_accept_invalid_certs.

pub fn compression(self, enabled: bool) -> Self

See Request::compression.

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

See Request::auth.

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

See Request::basic_auth.

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

See Request::bearer_auth.

pub fn netrc(self) -> Self

See Request::netrc.

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

See Request::proxy_auth.

pub fn client_cert( self, cert: impl Into<PathBuf>, key: impl Into<PathBuf>, ) -> Self

See Request::client_cert.

pub fn max_body_size(self, limit: Option<u64>) -> Self

See Request::max_body_size.

pub fn request(&self, method: Method, url: &str) -> Request

Starts a request with this client’s defaults.

pub fn get(&self, url: &str) -> Request

pub fn post(&self, url: &str) -> Request

pub fn put(&self, url: &str) -> Request

pub fn patch(&self, url: &str) -> Request

pub fn delete(&self, url: &str) -> Request

pub fn head(&self, url: &str) -> Request

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate 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.