azure_core 0.33.0

Rust wrappers around Microsoft Azure REST APIs - Core crate
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

mod instrumentation;
mod user_agent;

pub use instrumentation::*;
use std::sync::Arc;
use typespec_client_core::http::policies::Policy;
pub use typespec_client_core::http::{
    ClientMethodOptions, ExponentialRetryOptions, FixedRetryOptions, LoggingOptions,
    PipelineOptions, RetryOptions, Transport,
};
pub use user_agent::*;

use crate::cloud::CloudConfiguration;

/// Client options allow customization of general client policies, retry options, and more.
#[derive(Clone, Debug, Default)]
pub struct ClientOptions {
    /// Policies called per call.
    pub per_call_policies: Vec<Arc<dyn Policy>>,

    /// Policies called per try.
    pub per_try_policies: Vec<Arc<dyn Policy>>,

    /// Retry options.
    pub retry: RetryOptions,

    /// Transport options.
    pub transport: Option<Transport>,

    /// User-Agent telemetry options.
    pub user_agent: UserAgentOptions,

    /// Options for request instrumentation, such as distributed tracing.
    ///
    /// If not specified, defaults to no instrumentation.
    ///
    pub instrumentation: InstrumentationOptions,

    /// Logging options
    ///
    /// Specifies which headers and query parameters should be logged. All headers and query parameters not in the allow list will be redacted.
    pub logging: LoggingOptions,

    /// Cloud configuration for the client. If None, the client will default to Azure Public Cloud.
    pub cloud: Option<Arc<CloudConfiguration>>,
}

pub(crate) struct CoreClientOptions {
    pub(crate) user_agent: UserAgentOptions,
    pub(crate) instrumentation: InstrumentationOptions,
}

impl ClientOptions {
    /// Efficiently deconstructs into owned [`typespec_client_core::http::ClientOptions`] as well as unwrapped or default Azure-specific options.
    ///
    /// If instead we implemented [`Into`], we'd have to clone Azure-specific options instead of moving memory of [`Some`] values.
    pub(in crate::http) fn deconstruct(
        self,
    ) -> (CoreClientOptions, typespec_client_core::http::ClientOptions) {
        let options = typespec_client_core::http::ClientOptions {
            per_call_policies: self.per_call_policies,
            per_try_policies: self.per_try_policies,
            retry: self.retry,
            transport: self.transport,
            logging: self.logging,
        };

        (
            CoreClientOptions {
                user_agent: self.user_agent,
                instrumentation: self.instrumentation,
            },
            options,
        )
    }
}