Struct ClientOptions

pub struct ClientOptions {
    pub timeout: TimeoutPolicy,
    /* private fields */
}

Client options allow customization of policies, retry options, and more.

Examples

You can override default options and even add your own per-call or per-retry policies:

use azure_core::{ClientOptions, ExponentialRetryOptions, RetryOptions, TelemetryOptions};
let options: ClientOptions = ClientOptions::default()
    .retry(RetryOptions::exponential(ExponentialRetryOptions::default().max_retries(10u32)))
    .telemetry(TelemetryOptions::default().application_id("my-application"));

Fields

timeout: TimeoutPolicy

Transport options.

Implementations

impl ClientOptions

pub fn new(transport: TransportOptions) -> Self

pub fn per_call_policies_mut(&mut self) -> &mut Vec<Arc<dyn Policy>>

A mutable reference to per-call policies.

pub fn per_retry_policies_mut(&mut self) -> &mut Vec<Arc<dyn Policy>>

A mutable reference to per-retry policies.

pub fn per_call_policies<P: Into<Vec<Arc<dyn Policy>>>>( self, per_call_policies: P, ) -> Self

pub fn per_retry_policies<P: Into<Vec<Arc<dyn Policy>>>>( self, per_retry_policies: P, ) -> Self

pub fn retry<P: Into<RetryOptions>>(self, retry: P) -> Self

pub fn telemetry<P: Into<TelemetryOptions>>(self, telemetry: P) -> Self

pub fn transport<P: Into<TransportOptions>>(self, transport: P) -> Self

pub fn timeout<P: Into<TimeoutPolicy>>(self, timeout: P) -> Self

Trait Implementations

impl Clone for ClientOptions

fn clone(&self) -> ClientOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientOptions

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

Formats the value using the given formatter.

impl Default for ClientOptions

fn default() -> ClientOptions

Returns the “default value” for a type.