Skip to main content

ClientOptions

azure_core::http

Struct ClientOptions

pub struct ClientOptions {
    pub per_call_policies: Vec<Arc<dyn Policy>>,
    pub per_try_policies: Vec<Arc<dyn Policy>>,
    pub retry: RetryOptions,
    pub transport: Option<Transport>,
    pub user_agent: UserAgentOptions,
    pub instrumentation: InstrumentationOptions,
    pub logging: LoggingOptions,
    pub cloud: Option<Arc<CloudConfiguration>>,
}

Expand description

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

Fields§

§per_call_policies: Vec<Arc<dyn Policy>>

Policies called per call.

§per_try_policies: Vec<Arc<dyn Policy>>

Policies called per try.

§retry: RetryOptions

Retry options.

§transport: Option<Transport>

Transport options.

§user_agent: UserAgentOptions

User-Agent telemetry options.

§instrumentation: InstrumentationOptions

Options for request instrumentation, such as distributed tracing.

If not specified, defaults to no instrumentation.

§logging: LoggingOptions

Logging options

Specifies which headers and query parameters should be logged. All headers and query parameters not in the allow list will be redacted.

§cloud: Option<Arc<CloudConfiguration>>

Cloud configuration for the client. If None, the client will default to Azure Public Cloud.

Trait Implementations§

impl Clone for ClientOptions

fn clone(&self) -> ClientOptions

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

impl Debug for ClientOptions

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

Formats the value using the given formatter. Read more

impl Default for ClientOptions

fn default() -> ClientOptions

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl !RefUnwindSafe for ClientOptions

impl !UnwindSafe for ClientOptions

impl Freeze for ClientOptions

impl Send for ClientOptions

impl Sync for ClientOptions

impl Unpin for ClientOptions

impl UnsafeUnpin for ClientOptions

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

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

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ServiceExt for T

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more

fn decompression(self) -> Decompression<Self>
where Self: Sized,

Decompress response bodies. Read more

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more