Skip to main content

ClientBuilder

Struct ClientBuilder 

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

A builder for Client.

Explicit options override environment variables, and environment variables override defaults. Environment values are trimmed, and blank values are ignored. ClientBuilder::build returns Error::Config for a missing or invalid API key or an invalid setting.

Implementations§

Source§

impl ClientBuilder

Source

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

Sets the API key. Else TYPESAFE_API_KEY. Required.

The key is trimmed and validated: empty keys and keys containing whitespace, control characters, or non-ASCII characters are rejected with Error::Config, without echoing the key.

Source

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

Sets the base URL. Else TYPESAFE_BASE_URL, else https://api.typesafe.ai. A trailing / is stripped.

Any base URL that implements the TypeSafe OpenAPI spec works, for example a gateway.

Source

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

Sets the model used when a request does not specify one. Else TYPESAFE_DEFAULT_MODEL, else jev-latest.

Source

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

Sets the per-attempt timeout, which covers connecting through reading the full response body. Defaults to 10 seconds. Must be > 0.

Source

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

Sets the default retry policy. Defaults to RetryPolicy::default.

Source

pub fn default_header( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Adds a default header sent on every request, for gateway attribution.

SDK-owned headers (Authorization, Accept, Content-Type, User-Agent, X-TypeSafe-SDK, X-TypeSafe-Runtime, X-TypeSafe-Retry-Count) always take precedence over caller headers.

Source

pub fn log_level(self, level: LogLevel) -> Self

Sets the log level. Else TYPESAFE_LOG_LEVEL, else off.

Source

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

Supplies a preconfigured reqwest client. One is built otherwise.

Source

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

Builds the client, validating all settings.

Trait Implementations§

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> 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, 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