couchbase 1.0.1

The official Couchbase Rust SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

/*
 *
 *  * Copyright (c) 2025 Couchbase, Inc.
 *  *
 *  * 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
 *  *
 *  *    http://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.
 *
 */

//! Options for bucket management operations.
//!
//! This module provides structures and implementations for options used in
//! various bucket management operations, such as creating, updating, and
//! deleting buckets. Each operation has an associated options struct that
//! can be used to customize the behavior of the operation, including
//! specifying a retry strategy in case of transient failures.
use crate::retry::RetryStrategy;
use std::sync::Arc;

/// Options for [`BucketManager::get_all_buckets`](crate::management::buckets::bucket_manager::BucketManager::get_all_buckets).
#[derive(Default, Debug, Clone)]
#[non_exhaustive]
pub struct GetAllBucketsOptions {
    /// The retry strategy to use in case of transient failures.
    pub retry_strategy: Option<Arc<dyn RetryStrategy>>,
}

impl GetAllBucketsOptions {
    /// Creates a new instance of [`GetAllBucketsOptions`].
    pub fn new() -> Self {
        Default::default()
    }

    /// Sets the retry strategy.
    pub fn retry_strategy(mut self, retry_strategy: Arc<dyn RetryStrategy>) -> Self {
        self.retry_strategy = Some(retry_strategy);
        self
    }
}

/// Options for [`BucketManager::get_bucket`](crate::management::buckets::bucket_manager::BucketManager::get_bucket).
#[derive(Default, Debug, Clone)]
#[non_exhaustive]
pub struct GetBucketOptions {
    /// The retry strategy to use in case of transient failures.
    pub retry_strategy: Option<Arc<dyn RetryStrategy>>,
}

impl GetBucketOptions {
    /// Creates a new instance of [`GetBucketOptions`].
    pub fn new() -> Self {
        Default::default()
    }

    /// Sets the retry strategy.
    pub fn retry_strategy(mut self, retry_strategy: Arc<dyn RetryStrategy>) -> Self {
        self.retry_strategy = Some(retry_strategy);
        self
    }
}

/// Options for [`BucketManager::create_bucket`](crate::management::buckets::bucket_manager::BucketManager::create_bucket).
#[derive(Default, Debug, Clone)]
#[non_exhaustive]
pub struct CreateBucketOptions {
    /// The retry strategy to use in case of transient failures.
    pub retry_strategy: Option<Arc<dyn RetryStrategy>>,
}

impl CreateBucketOptions {
    /// Creates a new instance of [`CreateBucketOptions`].
    pub fn new() -> Self {
        Default::default()
    }

    /// Sets the retry strategy.
    pub fn retry_strategy(mut self, retry_strategy: Arc<dyn RetryStrategy>) -> Self {
        self.retry_strategy = Some(retry_strategy);
        self
    }
}

/// Options for [`BucketManager::update_bucket`](crate::management::buckets::bucket_manager::BucketManager::update_bucket).
#[derive(Default, Debug, Clone)]
#[non_exhaustive]
pub struct UpdateBucketOptions {
    /// The retry strategy to use in case of transient failures.
    pub retry_strategy: Option<Arc<dyn RetryStrategy>>,
}

impl UpdateBucketOptions {
    /// Creates a new instance of [`UpdateBucketOptions`].
    pub fn new() -> Self {
        Default::default()
    }

    /// Sets the retry strategy.
    pub fn retry_strategy(mut self, retry_strategy: Arc<dyn RetryStrategy>) -> Self {
        self.retry_strategy = Some(retry_strategy);
        self
    }
}

/// Options for [`BucketManager::drop_bucket`](crate::management::buckets::bucket_manager::BucketManager::drop_bucket).
#[derive(Default, Debug, Clone)]
#[non_exhaustive]
pub struct DropBucketOptions {
    /// The retry strategy to use in case of transient failures.
    pub retry_strategy: Option<Arc<dyn RetryStrategy>>,
}

impl DropBucketOptions {
    /// Creates a new instance of [`DropBucketOptions`].
    pub fn new() -> Self {
        Default::default()
    }

    /// Sets the retry strategy.
    pub fn retry_strategy(mut self, retry_strategy: Arc<dyn RetryStrategy>) -> Self {
        self.retry_strategy = Some(retry_strategy);
        self
    }
}

/// Options for [`BucketManager::flush_bucket`](crate::management::buckets::bucket_manager::BucketManager::flush_bucket).
#[derive(Default, Debug, Clone)]
#[non_exhaustive]
pub struct FlushBucketOptions {
    /// The retry strategy to use in case of transient failures.
    pub retry_strategy: Option<Arc<dyn RetryStrategy>>,
}

impl FlushBucketOptions {
    /// Creates a new instance of [`FlushBucketOptions`].
    pub fn new() -> Self {
        Default::default()
    }

    /// Sets the retry strategy.
    pub fn retry_strategy(mut self, retry_strategy: Arc<dyn RetryStrategy>) -> Self {
        self.retry_strategy = Some(retry_strategy);
        self
    }
}