///
/// HybridStreamingResultSpec.hpp
/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
/// https://github.com/mrousavy/nitro
/// Copyright © Marc Rousavy @ Margelo
///

#pragma once

#if __has_include(<NitroModules/HybridObject.hpp>)
#include <NitroModules/HybridObject.hpp>
#else
#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
#endif

// Forward declaration of `HybridQueryResultSpec` to properly resolve imports.
namespace margelo::nitro::rnduckdb { class HybridQueryResultSpec; }

#include <string>
#include <vector>
#include <memory>
#include "HybridQueryResultSpec.hpp"
#include <optional>
#include <NitroModules/Promise.hpp>
#include <functional>

namespace margelo::nitro::rnduckdb {

  using namespace margelo::nitro;

  /**
   * An abstract base class for `StreamingResult`
   * Inherit this class to create instances of `HybridStreamingResultSpec` in C++.
   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
   * @example
   * ```cpp
   * class HybridStreamingResult: public HybridStreamingResultSpec {
   * public:
   *   HybridStreamingResult(...): HybridObject(TAG) { ... }
   *   // ...
   * };
   * ```
   */
  class HybridStreamingResultSpec: public virtual HybridObject {
    public:
      // Constructor
      explicit HybridStreamingResultSpec(): HybridObject(TAG) { }

      // Destructor
      ~HybridStreamingResultSpec() override = default;

    public:
      // Properties
      virtual bool getIsDone() = 0;
      virtual double getColumnCount() = 0;
      virtual std::vector<std::string> getColumnNames() = 0;
      virtual std::vector<std::string> getColumnTypes() = 0;

    public:
      // Methods
      virtual std::shared_ptr<Promise<std::optional<std::shared_ptr<HybridQueryResultSpec>>>> fetchChunk() = 0;
      virtual void onChunk(const std::function<void(const std::shared_ptr<HybridQueryResultSpec>& /* chunk */)>& callback) = 0;
      virtual std::shared_ptr<Promise<void>> start() = 0;
      virtual void close() = 0;

    protected:
      // Hybrid Setup
      void loadHybridMethods() override;

    protected:
      // Tag for logging
      static constexpr auto TAG = "StreamingResult";
  };

} // namespace margelo::nitro::rnduckdb