Struct trillium_client::Client

source ·

pub struct Client<C: Connector> { /* private fields */ }

Expand description

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

Implementations§

source §

impl<C: Connector> Client<C>

source

pub fn new() -> Self

Constructs a new Client without a connection pool and with default configuration.

source

pub fn with_default_pool(self) -> Self

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

use trillium_smol::TcpConnector;
use trillium_client::Client;

let client = Client::<TcpConnector>::new()
    .with_default_pool(); //<-

source

pub fn with_config(self, config: C::Config) -> Self

chainable constructor to specify Connector configuration. this can be combined with Client::with_default_pool

use trillium_smol::{TcpConnector, ClientConfig};
use trillium_client::Client;

let client = Client::<TcpConnector>::new()
    .with_config(ClientConfig { //<-
        nodelay: Some(true),
        ..Default::default()
    });

source

pub fn build_conn<M, U>(&self, method: M, url: U) -> Conn<'_, C>where M: TryInto<Method>, <M as TryInto<Method>>::Error: Debug, U: TryInto<Url>, >::Error: Debug,

builds a new conn borrowing the config on this client. 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::{TcpConnector, ClientConfig};
use trillium_client::Client;
use trillium_testing::prelude::*;
let client = Client::<TcpConnector>::new();

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

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

source

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.

source

pub fn get(&self, url: U) -> Conn<'_, C>where >::Error: Debug, U: TryInto<Url>,

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

let client = Client::<TcpConnector>::new();
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");

source

pub fn post(&self, url: U) -> Conn<'_, C>where >::Error: Debug, U: TryInto<Url>,

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

let client = Client::<TcpConnector>::new();
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");

source

pub fn put(&self, url: U) -> Conn<'_, C>where >::Error: Debug, U: TryInto<Url>,

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

let client = Client::<TcpConnector>::new();
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");

source

pub fn delete(&self, url: U) -> Conn<'_, C>where >::Error: Debug, U: TryInto<Url>,

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

let client = Client::<TcpConnector>::new();
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");

source

pub fn patch(&self, url: U) -> Conn<'_, C>where >::Error: Debug, U: TryInto<Url>,

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

let client = Client::<TcpConnector>::new();
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");