Struct twilight_http::client::ClientBuilder

pub struct ClientBuilder { /* fields omitted */ }

A builder for Client.

Implementations

impl ClientBuilder

pub fn new() -> Self

Create a new builder to create a Client.

pub fn build(self) -> Client

Build the Client.

pub fn application_id(self, application_id: ApplicationId) -> Self

Set the ApplicationId used by interaction methods.

pub fn default_allowed_mentions(self, allowed_mentions: AllowedMentions) -> Self

Set the default allowed mentions setting to use on all messages sent through the HTTP client.

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

Set the proxy to use for all HTTP(S) requests.

Note that this isn’t currently a traditional proxy, but is for working with something like twilight’s HTTP proxy server.

Examples

Set the proxy to twilight_http_proxy.internal:

use twilight_http::Client;

let client = Client::builder()
    .proxy("twilight_http_proxy.internal", true)
    .build();

pub fn ratelimiter(self, ratelimiter: impl Into<Option<Ratelimiter>>) -> Self

Set a ratelimiter to use.

If the argument is None then the client’s ratelimiter will be skipped before making a request.

If this method is not called at all then a default ratelimiter will be created by ClientBuilder::build.

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

Set the timeout for HTTP requests.

The default is 10 seconds.

pub fn default_headers(self, headers: HeaderMap) -> Self

Set a group headers which are sent in every request.

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

Set the token to use for HTTP requests.

Trait Implementations

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.