Skip to main content

google_cloud_spanner/generated/gapic_dataplane/
stub.rs

1// Copyright 2026 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//! Traits to mock the clients in this library.
18//!
19//! Application developers may need to mock the clients in this library to test
20//! how their application works with different (and sometimes hard to trigger)
21//! client and service behavior. Such test can define mocks implementing the
22//! trait(s) defined in this module, initialize the client with an instance of
23//! this mock in their tests, and verify their application responds as expected.
24
25#![allow(rustdoc::broken_intra_doc_links)]
26
27pub(crate) mod dynamic;
28
29/// Defines the trait used to implement [super::client::Spanner].
30///
31/// Application developers may need to implement this trait to mock
32/// `client::Spanner`.  In other use-cases, application developers only
33/// use `client::Spanner` and need not be concerned with this trait or
34/// its implementations.
35///
36/// Services gain new RPCs routinely. Consequently, this trait gains new methods
37/// too. To avoid breaking applications the trait provides a default
38/// implementation of each method. Most of these implementations just return an
39/// error.
40pub trait Spanner: std::fmt::Debug + Send + Sync {
41    /// Implements [super::client::Spanner::create_session].
42    fn create_session(
43        &self,
44        _req: crate::model::CreateSessionRequest,
45        _options: crate::RequestOptions,
46    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Session>>> + Send
47    {
48        gaxi::unimplemented::unimplemented_stub()
49    }
50
51    /// Implements [super::client::Spanner::batch_create_sessions].
52    fn batch_create_sessions(
53        &self,
54        _req: crate::model::BatchCreateSessionsRequest,
55        _options: crate::RequestOptions,
56    ) -> impl std::future::Future<
57        Output = crate::Result<crate::Response<crate::model::BatchCreateSessionsResponse>>,
58    > + Send {
59        gaxi::unimplemented::unimplemented_stub()
60    }
61
62    /// Implements [super::client::Spanner::get_session].
63    fn get_session(
64        &self,
65        _req: crate::model::GetSessionRequest,
66        _options: crate::RequestOptions,
67    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Session>>> + Send
68    {
69        gaxi::unimplemented::unimplemented_stub()
70    }
71
72    /// Implements [super::client::Spanner::list_sessions].
73    fn list_sessions(
74        &self,
75        _req: crate::model::ListSessionsRequest,
76        _options: crate::RequestOptions,
77    ) -> impl std::future::Future<
78        Output = crate::Result<crate::Response<crate::model::ListSessionsResponse>>,
79    > + Send {
80        gaxi::unimplemented::unimplemented_stub()
81    }
82
83    /// Implements [super::client::Spanner::delete_session].
84    fn delete_session(
85        &self,
86        _req: crate::model::DeleteSessionRequest,
87        _options: crate::RequestOptions,
88    ) -> impl std::future::Future<Output = crate::Result<crate::Response<()>>> + Send {
89        gaxi::unimplemented::unimplemented_stub()
90    }
91
92    /// Implements [super::client::Spanner::execute_sql].
93    fn execute_sql(
94        &self,
95        _req: crate::model::ExecuteSqlRequest,
96        _options: crate::RequestOptions,
97    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::ResultSet>>> + Send
98    {
99        gaxi::unimplemented::unimplemented_stub()
100    }
101
102    /// Implements [super::client::Spanner::execute_batch_dml].
103    fn execute_batch_dml(
104        &self,
105        _req: crate::model::ExecuteBatchDmlRequest,
106        _options: crate::RequestOptions,
107    ) -> impl std::future::Future<
108        Output = crate::Result<crate::Response<crate::model::ExecuteBatchDmlResponse>>,
109    > + Send {
110        gaxi::unimplemented::unimplemented_stub()
111    }
112
113    /// Implements [super::client::Spanner::read].
114    fn read(
115        &self,
116        _req: crate::model::ReadRequest,
117        _options: crate::RequestOptions,
118    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::ResultSet>>> + Send
119    {
120        gaxi::unimplemented::unimplemented_stub()
121    }
122
123    /// Implements [super::client::Spanner::begin_transaction].
124    fn begin_transaction(
125        &self,
126        _req: crate::model::BeginTransactionRequest,
127        _options: crate::RequestOptions,
128    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Transaction>>>
129    + Send {
130        gaxi::unimplemented::unimplemented_stub()
131    }
132
133    /// Implements [super::client::Spanner::commit].
134    fn commit(
135        &self,
136        _req: crate::model::CommitRequest,
137        _options: crate::RequestOptions,
138    ) -> impl std::future::Future<
139        Output = crate::Result<crate::Response<crate::model::CommitResponse>>,
140    > + Send {
141        gaxi::unimplemented::unimplemented_stub()
142    }
143
144    /// Implements [super::client::Spanner::rollback].
145    fn rollback(
146        &self,
147        _req: crate::model::RollbackRequest,
148        _options: crate::RequestOptions,
149    ) -> impl std::future::Future<Output = crate::Result<crate::Response<()>>> + Send {
150        gaxi::unimplemented::unimplemented_stub()
151    }
152
153    /// Implements [super::client::Spanner::partition_query].
154    fn partition_query(
155        &self,
156        _req: crate::model::PartitionQueryRequest,
157        _options: crate::RequestOptions,
158    ) -> impl std::future::Future<
159        Output = crate::Result<crate::Response<crate::model::PartitionResponse>>,
160    > + Send {
161        gaxi::unimplemented::unimplemented_stub()
162    }
163
164    /// Implements [super::client::Spanner::partition_read].
165    fn partition_read(
166        &self,
167        _req: crate::model::PartitionReadRequest,
168        _options: crate::RequestOptions,
169    ) -> impl std::future::Future<
170        Output = crate::Result<crate::Response<crate::model::PartitionResponse>>,
171    > + Send {
172        gaxi::unimplemented::unimplemented_stub()
173    }
174}