Skip to main content

ClientBuilder

Struct ClientBuilder 

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

Builds a Client.

Requires either a static token, or both an API key and a secret. Credentials fall back to the VIDEOSDK_API_KEY and VIDEOSDK_SECRET environment variables, and the endpoint to VIDEOSDK_API_ENDPOINT.

let client = videosdk::Client::builder()
    .api_key("my-key")
    .secret("my-secret")
    .max_retries(3)
    .build()?;

Implementations§

Source§

impl ClientBuilder

Source

pub fn new() -> Self

Starts a new builder.

Source

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

Sets the project API key. Falls back to VIDEOSDK_API_KEY.

Source

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

Sets the project secret. Falls back to VIDEOSDK_SECRET.

Source

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

Sets the API endpoint. Falls back to VIDEOSDK_API_ENDPOINT, then to DEFAULT_BASE_URL.

Source

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

Uses a pre-generated static token. Disables automatic token refresh unless an API key and secret are also supplied.

Source

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

Supplies a preconfigured reqwest::Client, e.g. with a proxy or a custom connection pool.

Source

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

Sets how many times a failed request is retried. Defaults to 2, giving up to 3 total attempts.

Source

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

Sets the per-request timeout. Defaults to 30 seconds; Duration::ZERO disables it.

This applies to each attempt individually, so a request that exhausts its retries can take longer than this in total.

Source

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

Adds a header sent with every request.

Source

pub fn token_options(self, token_options: TokenOptions) -> Self

Overrides the claims of the tokens the client mints for its own requests.

Source

pub fn backoff( self, backoff: impl Fn(u32) -> Duration + Send + Sync + 'static, ) -> Self

Replaces the retry backoff.

The default is exponential — min(2^attempt seconds, 8s) plus up to 249 ms of jitter — where attempt is the zero-based retry counter.

Source

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

Builds the client, resolving credentials from the environment where they were not set explicitly.

Trait Implementations§

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