google-cloud-storage 1.11.0

// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Code generated by sidekick. DO NOT EDIT.

//! Traits to mock the clients in this library.
//!
//! Application developers may need to mock the clients in this library to test
//! how their application works with different (and sometimes hard to trigger)
//! client and service behavior. Such test can define mocks implementing the
//! trait(s) defined in this module, initialize the client with an instance of
//! this mock in their tests, and verify their application responds as expected.

#![allow(rustdoc::broken_intra_doc_links)]

pub(crate) mod dynamic;

/// Defines the trait used to implement [super::client::StorageControl].
///
/// Application developers may need to implement this trait to mock
/// `client::StorageControl`.  In other use-cases, application developers only
/// use `client::StorageControl` and need not be concerned with this trait or
/// its implementations.
///
/// Services gain new RPCs routinely. Consequently, this trait gains new methods
/// too. To avoid breaking applications the trait provides a default
/// implementation of each method. Most of these implementations just return an
/// error.
pub trait StorageControl: std::fmt::Debug + Send + Sync {
    /// Implements [super::client::StorageControl::delete_bucket].
    fn delete_bucket(
        &self,
        _req: crate::model::DeleteBucketRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<Output = crate::Result<crate::Response<()>>> + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::StorageControl::get_bucket].
    fn get_bucket(
        &self,
        _req: crate::model::GetBucketRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Bucket>>> + Send
    {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::StorageControl::create_bucket].
    fn create_bucket(
        &self,
        _req: crate::model::CreateBucketRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Bucket>>> + Send
    {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::StorageControl::list_buckets].
    fn list_buckets(
        &self,
        _req: crate::model::ListBucketsRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<
        Output = crate::Result<crate::Response<crate::model::ListBucketsResponse>>,
    > + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::StorageControl::lock_bucket_retention_policy].
    fn lock_bucket_retention_policy(
        &self,
        _req: crate::model::LockBucketRetentionPolicyRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Bucket>>> + Send
    {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::StorageControl::update_bucket].
    fn update_bucket(
        &self,
        _req: crate::model::UpdateBucketRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Bucket>>> + Send
    {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::StorageControl::compose_object].
    fn compose_object(
        &self,
        _req: crate::model::ComposeObjectRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Object>>> + Send
    {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::StorageControl::delete_object].
    fn delete_object(
        &self,
        _req: crate::model::DeleteObjectRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<Output = crate::Result<crate::Response<()>>> + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::StorageControl::restore_object].
    fn restore_object(
        &self,
        _req: crate::model::RestoreObjectRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Object>>> + Send
    {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::StorageControl::get_object].
    fn get_object(
        &self,
        _req: crate::model::GetObjectRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Object>>> + Send
    {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::StorageControl::update_object].
    fn update_object(
        &self,
        _req: crate::model::UpdateObjectRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Object>>> + Send
    {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::StorageControl::list_objects].
    fn list_objects(
        &self,
        _req: crate::model::ListObjectsRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<
        Output = crate::Result<crate::Response<crate::model::ListObjectsResponse>>,
    > + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::StorageControl::rewrite_object].
    fn rewrite_object(
        &self,
        _req: crate::model::RewriteObjectRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<
        Output = crate::Result<crate::Response<crate::model::RewriteResponse>>,
    > + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::StorageControl::move_object].
    fn move_object(
        &self,
        _req: crate::model::MoveObjectRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Object>>> + Send
    {
        gaxi::unimplemented::unimplemented_stub()
    }
}