search_sort_field.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *   Copyright 2023-Present Couchbase, Inc.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
 
#pragma once
 
#include <couchbase/search_sort.hxx>
#include <couchbase/search_sort_field_missing.hxx>
#include <couchbase/search_sort_field_mode.hxx>
#include <couchbase/search_sort_field_type.hxx>
 
#include <string>
 
namespace couchbase
{
class search_sort_field : public search_sort
{
public:
  explicit search_sort_field(std::string field)
    : field_{ std::move(field) }
  {
  }
 
  search_sort_field(std::string field, bool descending)
    : search_sort{ descending }
    , field_{ std::move(field) }
  {
  }

  auto descending(bool desc) -> search_sort_field&;

  auto type(search_sort_field_type value) -> search_sort_field&;

  auto mode(search_sort_field_mode value) -> search_sort_field&;

  auto missing(search_sort_field_missing value) -> search_sort_field&;

  [[nodiscard]] auto encode() const -> encoded_search_sort override;
 
private:
  std::string field_;
  std::optional<search_sort_field_type> type_{};
  std::optional<search_sort_field_mode> mode_{};
  std::optional<search_sort_field_missing> missing_{};
};
} // namespace couchbase