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//! **NOTE:** This crate used to contain a different implementation, with a
25//! different surface. [@yoshidan](https://github.com/yoshidan) generously
26//! donated the crate name to Google. Their crate continues to live as
27//! [gcloud-storage].
28//!
29//! [gcloud-storage]: https://crates.io/crates/gcloud-storage
30//! [Google Cloud Storage]: https://cloud.google.com/storage
31
32pub use gax::Result;
33pub use gax::error::Error;
34
35pub mod backoff_policy;
36pub mod read_object;
37pub mod read_resume_policy;
38pub mod retry_policy;
39pub use crate::storage::request_options;
40pub use crate::storage::streaming_source;
41
42mod control;
43mod storage;
44
45pub mod client {
46    //! Clients to interact with Google Cloud Storage.
47    pub use crate::control::client::StorageControl;
48    pub use crate::storage::client::Storage;
49}
50pub mod builder {
51    //! Request builders.
52    pub mod storage {
53        //! Request builders for [Storage][crate::client::Storage].
54        pub use crate::storage::client::ClientBuilder;
55        pub use crate::storage::read_object::ReadObject;
56        pub use crate::storage::write_object::WriteObject;
57    }
58    pub mod storage_control {
59        //! Request builders for [StorageControl][crate::client::StorageControl].
60        pub use crate::control::builder::*;
61        pub use crate::control::client::ClientBuilder;
62    }
63}
64pub mod error;
65/// The messages and enums that are part of this client library.
66pub use crate::control::model;
67pub mod builder_ext;
68pub mod model_ext;
69pub mod stub {
70    //! Traits to mock the clients in this library.
71    //!
72    //! Application developers may need to mock the clients in this library to test
73    //! how their application works with different (and sometimes hard to trigger)
74    //! client and service behavior. Such test can define mocks implementing the
75    //! trait(s) defined in this module, initialize the client with an instance of
76    //! this mock in their tests, and verify their application responds as expected.
77    pub use crate::control::stub::*;
78    pub use crate::storage::stub::*;
79    pub use crate::storage::transport::Storage as DefaultStorage;
80}
81
82#[allow(dead_code)]
83pub(crate) mod generated;
84
85#[allow(dead_code)]
86pub(crate) mod google {
87    pub mod iam {
88        pub mod v1 {
89            include!("generated/protos/storage/google.iam.v1.rs");
90            include!("generated/convert/iam/convert.rs");
91        }
92    }
93    pub mod longrunning {
94        include!("generated/protos/control/google.longrunning.rs");
95        include!("generated/convert/longrunning/convert.rs");
96    }
97    pub mod r#type {
98        include!("generated/protos/storage/google.r#type.rs");
99        include!("generated/convert/type/convert.rs");
100    }
101    pub mod rpc {
102        include!("generated/protos/storage/google.rpc.rs");
103    }
104    pub mod storage {
105        #[allow(deprecated)]
106        #[allow(clippy::large_enum_variant)]
107        pub mod v2 {
108            include!("generated/protos/storage/google.storage.v2.rs");
109            include!("generated/convert/storage/convert.rs");
110        }
111        pub mod control {
112            pub mod v2 {
113                include!("generated/protos/control/google.storage.control.v2.rs");
114                include!("generated/convert/control/convert.rs");
115            }
116        }
117    }
118}