DocumentId.hpp

#ifndef DITTO_DOCUMENT_ID_H
#define DITTO_DOCUMENT_ID_H
 
#include "DocumentIdPath.hpp"
 
#include <functional>
#include <string>
#include <vector>
 
#include "json.hpp"
 
#include "dittoffi.hpp"
 
namespace ditto {

// TODO(v5): Remove DocumentId, but need to change
// QueryResult::mutated_document_ids to another type.
struct DocumentId {
  friend class Collection;
  friend class Document;
  friend class DocumentOperator;
  friend class PendingIDSpecificOperation;
  friend class QueryOperator;
  friend class ScopedWriteTransaction;
  friend struct DocumentIdHasher;
  friend class QueryResult;
 
  DocumentId() = default;

  explicit DocumentId(nlohmann::json id_value);
 
  bool operator==(const DocumentId &rhs) const;
  bool operator!=(const DocumentId &rhs) const;
 
  DITTO_DISABLE_DEPRECATED_WARNINGS("DocumentIdPath is deprecated")
 
  
  DocumentIdPath operator[](std::string key) const;

  DocumentIdPath operator[](std::size_t index) const;
 
  DITTO_REENABLE_WARNINGS

  bool empty() const;

  nlohmann::json value() const;

  std::string to_string() const;
 
private:
  std::vector<uint8_t> id_bytes;
 
  std::string formatted_for_query_string(
      StringPrimitiveFormat_t string_primitive_format) const;
 
  explicit DocumentId(CDocument_t *doc_ptr);
  explicit DocumentId(slice_boxed_uint8_t);
  explicit DocumentId(std::vector<uint8_t> id_bytes);
};
 
void to_json(nlohmann::json &j, const DocumentId &d_id);
 
std::vector<uint8_t> validate_id_cbor(nlohmann::json &input_val);

 
// TODO(v5): Remove DocumentIdHasher, which is only used by the legacy query
// builder API.
struct DITTO_DEPRECATED_BECAUSE(
    "Use DQL (Ditto Query Language) instead. For more information see: "
    "https://ditto.com/link/legacy-to-dql-guide") DocumentIdHasher {
  std::size_t operator()(const DocumentId &k) const {
    // Taken from Boost's `boost::hash_combine`. See discussion here:
    // https://stackoverflow.com/questions/4948780/magic-number-in-boosthash-combine
    std::size_t seed = k.id_bytes.size();
    for (const auto &i : k.id_bytes) {
      // NOLINTNEXTLINE(hicpp-signed-bitwise)
      seed ^= i + 0x9e3779b9 + (seed << 6) + (seed >> 2);
    }
    return seed;
  }
};

 
} // namespace ditto
 
#endif