google_cloud_location/
lib.rs

1// Copyright 2024 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     https://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14//
15// Code generated by sidekick. DO NOT EDIT.
16
17//! Google Cloud Client Libraries for Rust - Cloud Metadata API
18//!
19//! This crate contains traits, types, and functions to interact with Cloud Metadata API
20//! Most applications will use the structs defined in the [client] module.
21//!
22//! The client library types and functions are stable and not expected to change.
23//! Please note that Google Cloud services do change from time to time. The client
24//! libraries are designed to preserve backwards compatibility when the service
25//! changes in compatible ways. For example, adding RPCs, or fields to messages
26//! should not introduce breaking changes to the client libraries.
27//!
28//! # Available Clients
29//!
30//! * [Locations](client/struct.Locations.html)
31//!
32//! # Features
33//!
34//! - `default-rustls-provider`: enabled by default. Use the default rustls
35//!   crypto provider ([aws-lc-rs]) for TLS and authentication. Applications
36//!   with specific requirements for cryptography (such as exclusively using the
37//!   [ring] crate) should disable this default and call
38//!   `rustls::crypto::CryptoProvider::install_default()`.
39//!
40//! [aws-lc-rs]: https://crates.io/crates/aws-lc-rs
41//! [ring]: https://crates.io/crates/ring
42
43/// The messages and enums that are part of this client library.
44#[allow(clippy::module_inception)]
45pub mod model;
46
47pub use google_cloud_gax::Result;
48pub use google_cloud_gax::error::Error;
49
50#[allow(rustdoc::invalid_html_tags)]
51#[allow(rustdoc::redundant_explicit_links)]
52pub mod stub;
53
54///
55/// # Example
56/// ```
57/// # use google_cloud_location::client::Locations;
58/// use google_cloud_gax::paginator::ItemPaginator as _;
59/// # async fn sample() -> Result<(), Box<dyn std::error::Error>> {
60///     let client = Locations::builder().build().await?;
61///     let mut list = client.list_locations()
62///         /* set fields */
63///         .by_item();
64///     while let Some(item) = list.next().await.transpose()? {
65///         println!("{:?}", item);
66///     }
67/// # Ok(()) }
68/// ```
69/// Concrete implementations of this client library traits.
70pub mod client;
71
72/// Request builders.
73pub mod builder;
74
75#[doc(hidden)]
76pub(crate) mod tracing;
77
78#[doc(hidden)]
79pub(crate) mod transport;
80
81/// The default host used by the service.
82const DEFAULT_HOST: &str = "https://cloud.googleapis.com/";
83
84pub(crate) mod info {
85    const NAME: &str = env!("CARGO_PKG_NAME");
86    const VERSION: &str = env!("CARGO_PKG_VERSION");
87    lazy_static::lazy_static! {
88        pub(crate) static ref X_GOOG_API_CLIENT_HEADER: String = {
89            let ac = gaxi::api_header::XGoogApiClient{
90                name:          NAME,
91                version:       VERSION,
92                library_type:  gaxi::api_header::GAPIC,
93            };
94            ac.rest_header_value()
95        };
96    }
97}
98
99// Define some shortcuts for imported crates.
100pub(crate) use google_cloud_gax::client_builder::ClientBuilder;
101pub(crate) use google_cloud_gax::client_builder::Result as ClientBuilderResult;
102pub(crate) use google_cloud_gax::client_builder::internal::ClientFactory;
103pub(crate) use google_cloud_gax::client_builder::internal::new_builder as new_client_builder;
104pub(crate) use google_cloud_gax::options::RequestOptions;
105pub(crate) use google_cloud_gax::options::internal::RequestBuilder;
106pub(crate) use google_cloud_gax::response::Response;
google_cloud_location/lib.rs

google_cloud_location/
lib.rs
