Couchbase C++ SDK
1.4.0 (rev. 59aa900)
Toggle main menu visibility
Loading...
Searching...
No Matches
lookup_in_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
20
#include <
couchbase/subdoc/fwd/command_bundle.hxx
>
21
22
#include <
couchbase/codec/encoded_value.hxx
>
23
#include <
couchbase/common_durability_options.hxx
>
24
#include <
couchbase/error.hxx
>
25
#include <
couchbase/expiry.hxx
>
26
#include <
couchbase/lookup_in_result.hxx
>
27
#include <
couchbase/store_semantics.hxx
>
28
29
#include <chrono>
30
#include <functional>
31
#include <memory>
32
#include <optional>
33
#include <vector>
34
35
namespace
couchbase
36
{
37
44
struct
lookup_in_options
:
public
common_durability_options
<lookup_in_options> {
51
struct
built
:
public
common_durability_options
<lookup_in_options>
::built
{
52
const
bool
access_deleted
;
53
};
54
66
[[nodiscard]]
auto
build
() const ->
built
67
{
68
auto
base =
build_common_durability_options
();
69
return
{ base, access_deleted_ };
70
}
71
78
auto
access_deleted
(
bool
value) ->
lookup_in_options
&
79
{
80
access_deleted_ = value;
81
return
self
();
82
}
83
84
private
:
85
bool
access_deleted_{
false
};
86
};
87
94
using
lookup_in_handler
= std::function<void(
error
,
lookup_in_result
)>;
95
}
// namespace couchbase
couchbase::common_durability_options
Common options that used by most operations.
Definition
common_durability_options.hxx:39
couchbase::common_durability_options< lookup_in_options >::build_common_durability_options
auto build_common_durability_options() const -> built
Definition
common_durability_options.hxx:115
couchbase::common_options< lookup_in_options >::self
auto self() -> lookup_in_options &
Definition
common_options.hxx:116
couchbase::error
Definition
error.hxx:31
couchbase::lookup_in_result
Represents result of lookup_in operations.
Definition
lookup_in_result.hxx:43
command_bundle.hxx
common_durability_options.hxx
encoded_value.hxx
error.hxx
expiry.hxx
lookup_in_result.hxx
couchbase
Represents a single item from the result of scan().
Definition
allow_querying_search_index_options.hxx:28
couchbase::lookup_in_handler
std::function< void(error, lookup_in_result)> lookup_in_handler
The signature for the handler of the lookup_in() operation.
Definition
lookup_in_options.hxx:94
store_semantics.hxx
couchbase::lookup_in_options::built
Immutable value object representing consistent options.
Definition
lookup_in_options.hxx:51
couchbase::lookup_in_options::built::access_deleted
const bool access_deleted
Definition
lookup_in_options.hxx:52
couchbase::lookup_in_options
Options for lookup_in().
Definition
lookup_in_options.hxx:44
couchbase::lookup_in_options::access_deleted
auto access_deleted(bool value) -> lookup_in_options &
For internal use only: allows access to deleted documents that are in 'tombstone' form.
Definition
lookup_in_options.hxx:78
couchbase::lookup_in_options::build
auto build() const -> built
Validates options and returns them as an immutable value.
Definition
lookup_in_options.hxx:66
couchbase
lookup_in_options.hxx
Generated by
1.17.0