google_cloud_storage/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//! Google Cloud Client Libraries for Rust - Storage
16//!
17//! This crate contains traits, types, and functions to interact with [Google
18//! Cloud Storage]. Most applications will use the structs defined in the
19//! [client] module. More specifically:
20//!
21//! * [Storage][client::Storage]
22//! * [StorageControl][client::StorageControl]
23//!
24//! **WARNING:** this crate is under active development. We expect multiple
25//! breaking changes in the upcoming releases. Testing is also incomplete, we do
26//! **not** recommend that you use this crate in production. We welcome feedback
27//! about the APIs, documentation, missing features, bugs, etc.
28//!
29//! **NOTE:** This crate used to contain a different implementation, with a
30//! different surface. [@yoshidan](https://github.com/yoshidan) generously
31//! donated the crate name to Google. Their crate continues to live as
32//! [gcloud-storage].
33//!
34//! [gcloud-storage]: https://crates.io/crates/gcloud-storage
35//! [Google Cloud Storage]: https://cloud.google.com/storage
36
37pub use gax::Result;
38pub use gax::error::Error;
39
40pub mod backoff_policy;
41pub mod read_object;
42pub mod read_resume_policy;
43pub mod retry_policy;
44pub use crate::storage::request_options;
45pub use crate::storage::streaming_source;
46
47mod control;
48mod storage;
49
50pub mod client {
51 //! Clients to interact with Google Cloud Storage.
52 pub use crate::control::client::StorageControl;
53 pub use crate::storage::client::Storage;
54}
55pub mod builder {
56 //! Request builders.
57 pub mod storage {
58 //! Request builders for [Storage][crate::client::Storage].
59 pub use crate::storage::client::ClientBuilder;
60 pub use crate::storage::read_object::ReadObject;
61 pub use crate::storage::write_object::WriteObject;
62 }
63 pub mod storage_control {
64 //! Request builders for [StorageControl][crate::client::StorageControl].
65 pub use crate::control::builder::*;
66 pub use crate::control::client::ClientBuilder;
67 }
68}
69pub mod error;
70/// The messages and enums that are part of this client library.
71pub use crate::control::model;
72pub mod model_ext;
73pub mod stub {
74 pub use crate::control::stub::*;
75 pub use crate::storage::stub::*;
76}
77
78#[allow(dead_code)]
79pub(crate) mod generated;
80
81#[allow(dead_code)]
82pub(crate) mod google {
83 pub mod iam {
84 pub mod v1 {
85 include!("generated/protos/storage/google.iam.v1.rs");
86 include!("generated/convert/iam/convert.rs");
87 }
88 }
89 pub mod longrunning {
90 include!("generated/protos/control/google.longrunning.rs");
91 include!("generated/convert/longrunning/convert.rs");
92 }
93 pub mod r#type {
94 include!("generated/protos/storage/google.r#type.rs");
95 include!("generated/convert/type/convert.rs");
96 }
97 pub mod rpc {
98 include!("generated/protos/storage/google.rpc.rs");
99 }
100 pub mod storage {
101 #[allow(deprecated)]
102 #[allow(clippy::large_enum_variant)]
103 pub mod v2 {
104 include!("generated/protos/storage/google.storage.v2.rs");
105 include!("generated/convert/storage/convert.rs");
106 }
107 pub mod control {
108 pub mod v2 {
109 include!("generated/protos/control/google.storage.control.v2.rs");
110 include!("generated/convert/control/convert.rs");
111 }
112 }
113 }
114}