Skip to main content

ClientBuilder

Struct ClientBuilder 

Source
pub struct ClientBuilder { /* private fields */ }
Expand description

Configures and builds a client.

Implementations§

Source§

impl ClientBuilder

Source

pub fn new() -> Self

A builder with every default.

Source

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

The API key. Without it the client reads the API key environment variable (API_KEY_ENV).

Source

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

The API base URL. Defaults to the production URL (DEFAULT_BASE_URL).

Source

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

The timeout of each attempt, from connecting until the response body has been read. Defaults to 30 s.

Source

pub fn retry(self, retry: RetryPolicy) -> Self

The retry policy. Defaults to RetryPolicy::default.

Source

pub fn max_retries(self, max_retries: u32) -> Self

Retries after the first attempt, keeping the rest of the policy.

Source

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

Act inside one project: its id, or ext:<externalId>. Sent as the project header on every request. With a project API key it may be omitted (the key already names its project).

Source

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

Where the event stream is served, for an API that has one. Defaults to the stream’s production URL, or to the origin of the base URL when that is not the API’s production URL.

Source

pub fn http_client(self, client: Client) -> Self

A reqwest client to send requests with, to bring your own proxy, TLS or connection pool settings. The per-attempt timeout and the User-Agent of this crate still apply.

Source

pub fn build(self) -> Result<Client, Error>

Builds the client.

§Errors

Error::Config when there is no API key, the project is longer than 200 characters, or the HTTP client cannot be created.

Source

pub fn build_http(self) -> Result<HttpClient, Error>

Builds the low-level HTTP client.

§Errors

The same as ClientBuilder::build.

Trait Implementations§

Source§

impl Clone for ClientBuilder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ClientBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ClientBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more