Skip to main content

ClientBuilder

Struct ClientBuilder 

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

Fluent builder for Client. Use Client::builder to construct one.

Implementations§

Source§

impl ClientBuilder

Source

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

Authenticate with a static OpenApp API key. The base URL is derived from the token unless overridden via ClientBuilder::base_url.

Source

pub fn token_provider(self, provider: Arc<dyn TokenProvider>) -> ClientBuilder

Use a custom TokenProvider.

Source

pub fn base_url(self, url: impl AsRef<str>) -> Result<ClientBuilder, SdkError>

Override the API base URL. Rarely needed — an OpenApp API key embeds its base URL, so calling ClientBuilder::api_key usually suffices.

Source

pub fn user_agent(self, ua: impl Into<String>) -> ClientBuilder

Set the User-Agent header. Defaults to "openapp-sdk/<version>".

Source

pub fn default_timeout(self, timeout: Duration) -> ClientBuilder

Set the default per-request timeout.

Source

pub fn retry_policy(self, policy: RetryPolicy) -> ClientBuilder

Override the default retry policy.

Source

pub fn interceptor( self, interceptor: impl Interceptor + 'static, ) -> ClientBuilder

Add an Interceptor. Interceptors run in insertion order.

Source

pub fn reqwest_client(self, client: Client) -> ClientBuilder

Supply a pre-built reqwest::Client (e.g. with a custom TLS root bundle).

Source

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

Finalize the builder into a Client.

§Errors

Returns SdkError::Config when no authentication or base URL has been configured, or when a token-provider error has been deferred from ClientBuilder::api_key.

§Panics

Panics if the default reqwest::Client cannot be built. In practice this only happens if the host is missing TLS roots, which is treated as a programmer error rather than a recoverable condition.

Trait Implementations§

Source§

impl Debug for ClientBuilder

Source§

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

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

impl Default for ClientBuilder

Source§

fn default() -> ClientBuilder

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> 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: 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: 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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