google_cloud_oslogin_v1/lib.rs
1// Copyright 2025 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 OS Login API
18//!
19//! This crate contains traits, types, and functions to interact with Cloud OS Login 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//! * [OsLoginService](client/struct.OsLoginService.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_oslogin_v1::client::OsLoginService;
58/// # async fn sample() -> Result<(), Box<dyn std::error::Error>> {
59/// let client = OsLoginService::builder().build().await?;
60/// // use `client` to make requests to the Cloud OS Login API.
61/// # Ok(()) }
62/// ```
63/// Concrete implementations of this client library traits.
64pub mod client;
65
66/// Request builders.
67pub mod builder;
68
69#[doc(hidden)]
70pub(crate) mod tracing;
71
72#[doc(hidden)]
73pub(crate) mod transport;
74
75/// The default host used by the service.
76const DEFAULT_HOST: &str = "https://oslogin.googleapis.com/";
77
78pub(crate) mod info {
79 const NAME: &str = env!("CARGO_PKG_NAME");
80 const VERSION: &str = env!("CARGO_PKG_VERSION");
81 pub(crate) static X_GOOG_API_CLIENT_HEADER: std::sync::LazyLock<String> =
82 std::sync::LazyLock::new(|| {
83 let ac = gaxi::api_header::XGoogApiClient {
84 name: NAME,
85 version: VERSION,
86 library_type: gaxi::api_header::GAPIC,
87 };
88 ac.rest_header_value()
89 });
90}
91
92// Define some shortcuts for imported crates.
93pub(crate) use google_cloud_gax::client_builder::ClientBuilder;
94pub(crate) use google_cloud_gax::client_builder::Result as ClientBuilderResult;
95pub(crate) use google_cloud_gax::client_builder::internal::ClientFactory;
96pub(crate) use google_cloud_gax::client_builder::internal::new_builder as new_client_builder;
97pub(crate) use google_cloud_gax::options::RequestOptions;
98pub(crate) use google_cloud_gax::options::internal::RequestBuilder;
99pub(crate) use google_cloud_gax::response::Response;