Couchbase C++ SDK
1.4.0 (rev. 59aa900)
Toggle main menu visibility
Loading...
Searching...
No Matches
get.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.hxx
>
21
#include <
couchbase/subdoc/fwd/command_bundle.hxx
>
22
23
#include <
couchbase/subdoc/lookup_in_macro.hxx
>
24
25
#include <string>
26
#include <vector>
27
28
namespace
couchbase
29
{
30
class
lookup_in_specs
;
31
32
namespace
subdoc
33
{
40
class
get
41
{
42
public
:
52
auto
xattr
(
bool
value =
true
) -> get&
53
{
54
xattr_ = value;
55
return
*
this
;
56
}
57
67
auto
binary
(
bool
value =
true
) -> get&
68
{
69
binary_ = value;
70
return
*
this
;
71
}
72
73
private
:
74
#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
75
friend
couchbase::lookup_in_specs
;
76
#endif
77
78
explicit
get
(std::string path)
79
: path_(std::move(path))
80
{
81
}
82
83
explicit
get(
lookup_in_macro
macro)
84
: path_(
to_string
(macro))
85
, xattr_{ true }
86
{
87
}
88
89
void
encode(core::impl::subdoc::command_bundle& bundle)
const
;
90
91
std::string path_;
92
bool
xattr_{
false
};
93
bool
binary_{
false
};
94
};
95
}
// namespace subdoc
96
}
// namespace couchbase
couchbase::lookup_in_specs
Definition
lookup_in_specs.hxx:34
couchbase::subdoc::get
An intention to perform a SubDocument get operation.
Definition
get.hxx:41
couchbase::subdoc::get::xattr
auto xattr(bool value=true) -> get &
Sets that this is an extended attribute (XATTR) field.
Definition
get.hxx:52
couchbase::subdoc::get::binary
auto binary(bool value=true) -> get &
Sets whether the value should be treated as a binary.
Definition
get.hxx:67
command.hxx
command_bundle.hxx
lookup_in_macro.hxx
couchbase::subdoc
Definition
array_add_unique.hxx:33
couchbase::subdoc::lookup_in_macro
lookup_in_macro
Definition
lookup_in_macro.hxx:29
couchbase::subdoc::to_string
auto to_string(lookup_in_macro value) -> std::string
Converts macro into binary array suitable for sending to the server.
couchbase
Represents a single item from the result of scan().
Definition
allow_querying_search_index_options.hxx:28
couchbase
subdoc
get.hxx
Generated by
1.17.0