scan_result_item.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *   Copyright 2024. 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/cas.hxx>
#include <couchbase/codec/default_json_transcoder.hxx>
#include <couchbase/codec/encoded_value.hxx>
#include <couchbase/codec/transcoder_traits.hxx>
#include <couchbase/result.hxx>
 
#include <chrono>
#include <optional>
#include <string>
#include <type_traits>
#include <utility>
 
namespace couchbase
{
class scan_result_item : public result
{
public:
  scan_result_item() = default;
 
  scan_result_item(std::string id,
                   couchbase::cas cas,
                   codec::encoded_value value,
                   std::optional<std::chrono::system_clock::time_point> expiry_time)
    : result{ cas }
    , id_{ std::move(id) }
    , id_only_{ false }
    , value_{ std::move(value) }
    , expiry_time_{ expiry_time }
  {
  }
 
  explicit scan_result_item(std::string id)
    : id_{ std::move(id) }
    , id_only_{ true }
  {
  }
 
  bool operator==(const scan_result_item& other) const
  {
    return id_ == other.id_ && cas() == other.cas();
  }
 
  [[nodiscard]] auto id() const -> const std::string&
  {
    return id_;
  }
 
  [[nodiscard]] auto id_only() const -> bool
  {
    return id_only_;
  }
 
  template<typename Document,
           typename Transcoder = codec::default_json_transcoder,
           std::enable_if_t<!codec::is_transcoder_v<Document>, bool> = true,
           std::enable_if_t<codec::is_transcoder_v<Transcoder>, bool> = true>
  [[nodiscard]] auto content_as() const -> Document
  {
    if (id_only_) {
      return {};
    }
    return Transcoder::template decode<Document>(value_);
  }
 
  [[nodiscard]] auto expiry_time() const
    -> const std::optional<std::chrono::system_clock::time_point>&
  {
    return expiry_time_;
  }
 
private:
  std::string id_{};
  bool id_only_{};
  codec::encoded_value value_{};
  std::optional<std::chrono::system_clock::time_point> expiry_time_{};
};
} // namespace couchbase