Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
search_row_location.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 <cinttypes>
21#include <memory>
22#include <optional>
23#include <string>
24#include <vector>
25
26namespace couchbase
27{
28#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
29class internal_search_row_location;
30#endif
31
37{
38public:
43 explicit search_row_location(internal_search_row_location internal);
44
46
48
51
54
55 [[nodiscard]] auto field() const -> const std::string&;
56 [[nodiscard]] auto term() const -> const std::string&;
57 [[nodiscard]] auto position() const -> const std::uint64_t&;
58 [[nodiscard]] auto start_offset() const -> const std::uint64_t&;
59 [[nodiscard]] auto end_offset() const -> const std::uint64_t&;
60 [[nodiscard]] auto array_positions() const -> const std::optional<std::vector<std::uint64_t>>&;
61
62private:
63 std::unique_ptr<internal_search_row_location> internal_;
64};
65
66} // namespace couchbase
Definition search_row_location.hxx:37
search_row_location & operator=(const search_row_location &)=delete
search_row_location(internal_search_row_location internal)
auto position() const -> const std::uint64_t &
auto field() const -> const std::string &
auto end_offset() const -> const std::uint64_t &
search_row_location(const search_row_location &)=delete
auto term() const -> const std::string &
auto start_offset() const -> const std::uint64_t &
search_row_location(search_row_location &&) noexcept
auto array_positions() const -> const std::optional< std::vector< std::uint64_t > > &
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28