Couchbase C++ SDK
1.4.0 (rev. 59aa900)
Toggle main menu visibility
Loading...
Searching...
No Matches
diagnostics_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 2023-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/common_options.hxx
>
21
#include <
couchbase/diagnostics_result.hxx
>
22
23
#include <optional>
24
#include <utility>
25
26
namespace
couchbase
27
{
28
struct
diagnostics_options
:
public
common_options
<diagnostics_options> {
39
auto
report_id
(std::string
report_id
) ->
diagnostics_options
&
40
{
41
report_id_ = std::move(
report_id
);
42
return
self
();
43
}
44
51
struct
built
:
public
common_options
<diagnostics_options>
::built
{
52
std::optional<std::string>
report_id
;
53
};
54
66
[[nodiscard]]
auto
build
() const ->
built
67
{
68
return
{
build_common_options
(), report_id_ };
69
}
70
71
private
:
72
std::optional<std::string> report_id_{};
73
};
74
75
using
diagnostics_handler
= std::function<void(
error
,
diagnostics_result
)>;
76
}
// namespace couchbase
couchbase::common_options
Common options that used by most operations.
Definition
common_options.hxx:38
couchbase::common_options< diagnostics_options >::self
auto self() -> diagnostics_options &
Definition
common_options.hxx:116
couchbase::common_options< diagnostics_options >::build_common_options
auto build_common_options() const -> built
Definition
common_options.hxx:103
couchbase::diagnostics_result
Definition
diagnostics_result.hxx:32
couchbase::error
Definition
error.hxx:31
common_options.hxx
diagnostics_result.hxx
couchbase
Represents a single item from the result of scan().
Definition
allow_querying_search_index_options.hxx:28
couchbase::diagnostics_handler
std::function< void(error, diagnostics_result)> diagnostics_handler
Definition
diagnostics_options.hxx:75
couchbase::diagnostics_options::built
Immutable value object representing consistent options.
Definition
diagnostics_options.hxx:51
couchbase::diagnostics_options::built::report_id
std::optional< std::string > report_id
Definition
diagnostics_options.hxx:52
couchbase::diagnostics_options
Definition
diagnostics_options.hxx:28
couchbase::diagnostics_options::build
auto build() const -> built
Validates the options and returns them as an immutable value.
Definition
diagnostics_options.hxx:66
couchbase::diagnostics_options::report_id
auto report_id(std::string report_id) -> diagnostics_options &
Sets a custom report ID that will be used in the report.
Definition
diagnostics_options.hxx:39
couchbase
diagnostics_options.hxx
Generated by
1.17.0