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) -> Result<Client>

Build the Client.

Errors

Errors if reqwest fails to build the client.

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

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

pub fn proxy(mut self: Self, proxy: Proxy) -> Self

Sets the proxy to use for all HTTP requests.

This accepts a reqwest::Proxy.

pub fn proxy_http(mut self: Self, proxy_http: bool) -> Self

Set whether to proxy over HTTP.

The default is false.

pub fn reqwest_client(mut self: Self, client: ReqwestClientBuilder) -> Self

Set a pre-configured reqwest client builder to build off of.

The proxy and timeout settings in the reqwest client will be overridden by those in this builder.

The default client uses Rustls as its TLS backend.

pub fn ratelimiter(
    mut self: 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 fn timeout(mut self: Self, duration: Duration) -> Self

Set the timeout for HTTP requests.

The default is 10 seconds.

pub fn token(mut self: 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.