Struct trillium_client::Client

pub struct Client { /* private fields */ }

A client contains a Config and an optional connection pool and builds conns.

Implementations

impl Client

pub fn new(config: impl Connector) -> Self

builds a new client from this Connector

pub fn without_default_header( self, name: impl Into<HeaderName<'static>>, ) -> Self

chainable method to remove a header from default request headers

pub fn with_default_header( self, name: impl Into<HeaderName<'static>>, value: impl Into<HeaderValues>, ) -> Self

chainable method to insert a new default request header, replacing any existing value

pub fn default_headers(&self) -> &Headers

borrow the default headers

pub fn default_headers_mut(&mut self) -> &mut Headers

borrow the default headers mutably

calling this will copy-on-write if the default headers are shared with another client clone

pub fn with_default_pool(self) -> Self

chainable constructor to enable connection pooling. this can be combined with [Client::with_config]

use trillium_smol::ClientConfig;
use trillium_client::Client;

let client = Client::new(ClientConfig::default())
    .with_default_pool(); //<-

pub fn build_conn<M>(&self, method: M, url: impl IntoUrl) -> Conn

where M: TryInto<Method>, <M as TryInto<Method>>::Error: Debug,

builds a new conn.

if the client has pooling enabled and there is an available connection to the dns-resolved socket (ip and port), the new conn will reuse that when it is sent.

use trillium_smol::ClientConfig;
use trillium_client::Client;
use trillium_testing::prelude::*;
let client = Client::new(ClientConfig::default());

let conn = client.build_conn("get", "http://trillium.rs"); //<-

assert_eq!(conn.method(), Method::Get);
assert_eq!(conn.url().host_str().unwrap(), "trillium.rs");

pub fn connector(&self) -> &Arc<dyn ObjectSafeConnector>

borrow the connector for this client

pub fn clean_up_pool(&self)

The pool implementation currently accumulates a small memory footprint for each new host. If your application is reusing a pool against a large number of unique hosts, call this method intermittently.

pub fn with_base(self, base: impl IntoUrl) -> Self

chainable method to set the base for this client

pub fn base(&self) -> Option<&Url>

retrieve the base for this client, if any

pub fn build_url(&self, url: impl IntoUrl) -> Result<Url>

attempt to build a url from this IntoUrl and the Client::base, if set

pub fn set_base(&mut self, base: impl IntoUrl) -> Result<()>

set the base for this client

pub fn get(&self, url: impl IntoUrl) -> Conn

Builds a new client conn with the get http method and the provided url.

let client = Client::new(ClientConfig::default());
let conn = client.get("http://localhost:8080/some/route"); //<-

assert_eq!(conn.method(), Method::Get);
assert_eq!(conn.url().to_string(), "http://localhost:8080/some/route");

pub fn post(&self, url: impl IntoUrl) -> Conn

Builds a new client conn with the post http method and the provided url.

let client = Client::new(ClientConfig::default());
let conn = client.post("http://localhost:8080/some/route"); //<-

assert_eq!(conn.method(), Method::Post);
assert_eq!(conn.url().to_string(), "http://localhost:8080/some/route");

pub fn put(&self, url: impl IntoUrl) -> Conn

Builds a new client conn with the put http method and the provided url.

let client = Client::new(ClientConfig::default());
let conn = client.put("http://localhost:8080/some/route"); //<-

assert_eq!(conn.method(), Method::Put);
assert_eq!(conn.url().to_string(), "http://localhost:8080/some/route");

pub fn delete(&self, url: impl IntoUrl) -> Conn

Builds a new client conn with the delete http method and the provided url.

let client = Client::new(ClientConfig::default());
let conn = client.delete("http://localhost:8080/some/route"); //<-

assert_eq!(conn.method(), Method::Delete);
assert_eq!(conn.url().to_string(), "http://localhost:8080/some/route");

pub fn patch(&self, url: impl IntoUrl) -> Conn

Builds a new client conn with the patch http method and the provided url.

let client = Client::new(ClientConfig::default());
let conn = client.patch("http://localhost:8080/some/route"); //<-

assert_eq!(conn.method(), Method::Patch);
assert_eq!(conn.url().to_string(), "http://localhost:8080/some/route");

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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<T: Connector> From<T> for Client

fn from(connector: T) -> Self

Converts to this type from the input type.