Skip to main content

AmberBuilder

Struct AmberBuilder 

Source
pub struct AmberBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> AmberBuilder<S>

Source

pub fn build(self) -> Amber
where S: IsComplete,

Finish building and return the requested object

Source

pub fn client(self, value: Client) -> AmberBuilder<SetClient<S>>
where S::Client: IsUnset,

Required.

HTTP client for making requests.

Source

pub fn api_key(self, value: String) -> AmberBuilder<SetApiKey<S>>
where S::ApiKey: IsUnset,

Optional (Some / Option setters). Optional API key for authenticated requests.

Source

pub fn maybe_api_key(self, value: Option<String>) -> AmberBuilder<SetApiKey<S>>
where S::ApiKey: IsUnset,

Optional (Some / Option setters). Optional API key for authenticated requests.

Source

pub fn base_url(self, value: String) -> AmberBuilder<SetBaseUrl<S>>
where S::BaseUrl: IsUnset,

Required.

Base URL for the Amber API.

Source

pub fn max_retries(self, value: u32) -> AmberBuilder<SetMaxRetries<S>>
where S::MaxRetries: IsUnset,

Optional (Some / Option setters). Default: 3.

Maximum number of retry attempts for rate limit errors.

When the API returns HTTP 429 (rate limit exceeded), the client will automatically retry up to this many times. Set to 0 to disable retries, or use retry_on_rate_limit(false) for clearer intent.

Defaults to 3.

Source

pub fn maybe_max_retries( self, value: Option<u32>, ) -> AmberBuilder<SetMaxRetries<S>>
where S::MaxRetries: IsUnset,

Optional (Some / Option setters). Default: 3.

Maximum number of retry attempts for rate limit errors.

When the API returns HTTP 429 (rate limit exceeded), the client will automatically retry up to this many times. Set to 0 to disable retries, or use retry_on_rate_limit(false) for clearer intent.

Defaults to 3.

Source

pub fn retry_on_rate_limit( self, value: bool, ) -> AmberBuilder<SetRetryOnRateLimit<S>>
where S::RetryOnRateLimit: IsUnset,

Optional (Some / Option setters). Default: true.

Whether to automatically retry on rate limit errors.

When enabled (default), the client automatically waits and retries when hitting rate limits. The wait time is read from the RateLimit-Reset header, or defaults to 60 seconds if not present.

When disabled, rate limit errors are returned immediately as [AmberError::RateLimitExceeded].

Default to true.

Source

pub fn maybe_retry_on_rate_limit( self, value: Option<bool>, ) -> AmberBuilder<SetRetryOnRateLimit<S>>
where S::RetryOnRateLimit: IsUnset,

Optional (Some / Option setters). Default: true.

Whether to automatically retry on rate limit errors.

When enabled (default), the client automatically waits and retries when hitting rate limits. The wait time is read from the RateLimit-Reset header, or defaults to 60 seconds if not present.

When disabled, rate limit errors are returned immediately as [AmberError::RateLimitExceeded].

Default to true.

Auto Trait Implementations§

§

impl<S> Freeze for AmberBuilder<S>

§

impl<S = Empty> !RefUnwindSafe for AmberBuilder<S>

§

impl<S> Send for AmberBuilder<S>

§

impl<S> Sync for AmberBuilder<S>

§

impl<S> Unpin for AmberBuilder<S>

§

impl<S = Empty> !UnwindSafe for AmberBuilder<S>

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