gcp_sdk_gax/
lib.rs

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
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Google APIs helpers.
//!
//! **WARNING:** this crate is under active development. We expect multiple
//! breaking changes in the upcoming releases. Testing is also incomplete, we do
//! **not** recommend that you use this crate in production. We welcome feedback
//! about the APIs, documentation, missing features, bugs, etc.
//!
//! This crate contains a number of types and functions used in the
//! implementation of the Google Cloud Client Libraries for Rust.
//!
//! <div class="warning">
//! All the types, traits, and functions defined in the <code>unstable-sdk-client</code>
//! feature are <b>not</b> intended for general use. The APIs enabled by this
//! feature will remain unstable for the foreseeable future, even if used in
//! stable SDKs. We (the Google Cloud Client Libraries for Rust team) control both and will
//! change both if needed.
//! </div>

/// An alias of [std::result::Result] where the error is always [Error][crate::error::Error].
///
/// This is the result type used by all functions wrapping RPCs.
pub type Result<T> = std::result::Result<T, crate::error::Error>;

#[cfg(feature = "unstable-sdk-client")]
#[doc(hidden)]
pub mod query_parameter;

#[cfg(feature = "unstable-sdk-client")]
#[doc(hidden)]
pub mod path_parameter;

/// Implements helpers to create telemetry headers.
#[cfg(feature = "unstable-sdk-client")]
#[doc(hidden)]
pub mod api_header;

/// The core error types used by generated clients.
pub mod error;

/// Defines some types and traits to convert and use List RPCs as a Stream.
/// Async streams are not yet stable, so neither is the use of this feature.
#[cfg(feature = "unstable-stream")]
pub mod paginator;

/// Defines traits and helpers for HTTP client implementations.
#[cfg(feature = "unstable-sdk-client")]
#[doc(hidden)]
pub mod http_client;

pub mod backoff_policy;
pub mod exponential_backoff;
pub mod loop_state;
pub mod options;
pub mod polling_backoff_policy;
pub mod polling_policy;
pub mod retry_policy;
pub mod retry_throttler;