google_cloud_location/stub.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//! 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::Locations].
30///
31/// Application developers may need to implement this trait to mock
32/// `client::Locations`. In other use-cases, application developers only
33/// use `client::Locations` 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 Locations: std::fmt::Debug + Send + Sync {
41 /// Implements [super::client::Locations::list_locations].
42 fn list_locations(
43 &self,
44 _req: crate::model::ListLocationsRequest,
45 _options: gax::options::RequestOptions,
46 ) -> impl std::future::Future<
47 Output = crate::Result<gax::response::Response<crate::model::ListLocationsResponse>>,
48 > + Send {
49 gaxi::unimplemented::unimplemented_stub()
50 }
51
52 /// Implements [super::client::Locations::get_location].
53 fn get_location(
54 &self,
55 _req: crate::model::GetLocationRequest,
56 _options: gax::options::RequestOptions,
57 ) -> impl std::future::Future<
58 Output = crate::Result<gax::response::Response<crate::model::Location>>,
59 > + Send {
60 gaxi::unimplemented::unimplemented_stub()
61 }
62}