Skip to main content

Config

Struct Config 

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

Connection settings for a client.

SettingEnvironment variableDefault
api_keyTYPESAFE_API_KEYnone
base_urlTYPESAFE_BASE_URLhttps://api.typesafe.ai
modelTYPESAFE_DEFAULT_MODELjev-latest
timeout10 s per response
retryRetryPolicy::default
headerextra request headers

Config::from_env reads the environment variables, and the setters override them. The API key is kept out of Debug output.

A missing key is not an error here, so an app can start without one. Calls then fail with ErrorKind::NoApiKey without making a request.

use std::time::Duration;
use typesafe::Config;

let config = Config::from_env()
    .model("jev-1.13.0")
    .timeout(Duration::from_secs(5));

Implementations§

Source§

impl Config

Source

pub fn new() -> Self

The defaults, ignoring the environment.

Source

pub fn from_env() -> Self

The defaults, with the key, base URL and model taken from the environment where set. Blank values count as unset.

Source

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

Source

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

Source

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

The model calls use unless they name one. Pin a versioned model such as jev-1.13.0 once thresholds are tuned; jev-latest moves when a new release ships.

Source

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

How long to wait for each response.

Source

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

Source

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

An extra header sent with every request.

Source

pub fn is_configured(&self) -> bool

Whether there is an API key.

Source

pub fn default_model(&self) -> &str

The model calls use unless they name one.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

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 Config

Source§

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

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

impl Default for Config

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