Couchbase C++ SDK 1.0.2 (rev. 51f4775)
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
22
24
25#include <string>
26#include <vector>
27
28namespace couchbase
29{
30class lookup_in_specs;
31
32namespace subdoc
33{
40class get
41{
42public:
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
73private:
74#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
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
Definition lookup_in_specs.hxx:34
An intention to perform a SubDocument get operation.
Definition get.hxx:41
auto xattr(bool value=true) -> get &
Sets that this is an extended attribute (XATTR) field.
Definition get.hxx:52
auto binary(bool value=true) -> get &
Sets whether the value should be treated as a binary.
Definition get.hxx:67
lookup_in_macro
Definition lookup_in_macro.hxx:29
auto to_string(lookup_in_macro value) -> std::string
Converts macro into binary array suitable for sending to the server.
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28