Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
replace_options.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2/*
3 * Copyright 2020-Present Couchbase, Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#pragma once
19
22#include <couchbase/error.hxx>
23#include <couchbase/expiry.hxx>
25
26#include <chrono>
27#include <functional>
28#include <memory>
29#include <optional>
30#include <vector>
31
32namespace couchbase
33{
34
41struct replace_options : public common_durability_options<replace_options> {
48 struct built : public common_durability_options<replace_options>::built {
49 const std::uint32_t expiry;
50 const bool preserve_expiry;
52 };
53
65 [[nodiscard]] auto build() const -> built
66 {
68 return { base, expiry_, preserve_expiry_, cas_ };
69 }
70
87 auto preserve_expiry(bool preserve) -> replace_options&
88 {
89 preserve_expiry_ = preserve;
90 return self();
91 }
92
106 auto expiry(std::chrono::seconds duration) -> replace_options&
107 {
108 expiry_ = core::impl::expiry_relative(duration);
109 return self();
110 }
111
122 auto expiry(std::chrono::system_clock::time_point time_point) -> replace_options&
123 {
124 expiry_ = core::impl::expiry_absolute(time_point);
125 return self();
126 }
127
149 {
150
151 cas_ = cas;
152 return self();
153 }
154
155private:
156 std::uint32_t expiry_{ 0 };
157 bool preserve_expiry_{ false };
158 couchbase::cas cas_{};
159};
160
167using replace_handler = std::function<void(error, mutation_result)>;
168} // namespace couchbase
CAS is a special type that represented in protocol using unsigned 64-bit integer, but only equality c...
Definition cas.hxx:34
Common options that used by most operations.
Definition common_durability_options.hxx:39
auto build_common_durability_options() const -> built
Definition common_durability_options.hxx:100
auto self() -> replace_options &
Definition common_options.hxx:102
Definition error.hxx:30
Represents result of mutation operations.
Definition mutation_result.hxx:35
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28
std::function< void(error, mutation_result)> replace_handler
The signature for the handler of the collection::replace() operation.
Definition replace_options.hxx:167
Immutable value object representing consistent options.
Definition replace_options.hxx:48
const couchbase::cas cas
Definition replace_options.hxx:51
const bool preserve_expiry
Definition replace_options.hxx:50
const std::uint32_t expiry
Definition replace_options.hxx:49
Options for collection::replace().
Definition replace_options.hxx:41
auto cas(couchbase::cas cas) -> replace_options &
Specifies a CAS value that will be taken into account on the server side for optimistic concurrency.
Definition replace_options.hxx:148
auto build() const -> built
Validates options and returns them as an immutable value.
Definition replace_options.hxx:65
auto expiry(std::chrono::system_clock::time_point time_point) -> replace_options &
Sets the expiry for the document.
Definition replace_options.hxx:122
auto preserve_expiry(bool preserve) -> replace_options &
Specifies whether an existing document's expiry should be preserved.
Definition replace_options.hxx:87
auto expiry(std::chrono::seconds duration) -> replace_options &
Sets the expiry for the document.
Definition replace_options.hxx:106