cudftable.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION.
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#include <cudf/io/types.hpp>
#include <cudf/packed_types.hpp>
#include <cudf/table/table.hpp>
#include <cudf/utilities/default_stream.hpp>
#include <cudf/utilities/export.hpp>
#include <cudf/utilities/memory_resource.hpp>
 
#include <rmm/cuda_stream_view.hpp>
 
#include <utility>
 
namespace CUDF_EXPORT cudf {
namespace io::experimental {
 
class cudftable_writer_options_builder;
 
class cudftable_writer_options {
  sink_info _sink;
  table_view _table;
 
  friend cudftable_writer_options_builder;
 
  explicit cudftable_writer_options(sink_info sink, table_view table)
    : _sink(std::move(sink)), _table(std::move(table))
  {
  }
 
 public:
  static cudftable_writer_options_builder builder(sink_info const& sink, table_view const& table);
 
  [[nodiscard]] sink_info const& get_sink() const noexcept { return _sink; }
 
  [[nodiscard]] table_view const& get_table() const noexcept { return _table; }
 
  void set_sink(sink_info sink) { _sink = std::move(sink); }
};
 
class cudftable_writer_options_builder {
 public:
  explicit cudftable_writer_options_builder(sink_info const& sink, table_view const& table)
    : _options(sink, table)
  {
  }
 
  [[nodiscard]] cudftable_writer_options build() const { return _options; }
 
 private:
  cudftable_writer_options _options;
};
  // end of io_writers group
 
class cudftable_reader_options_builder;
 
class cudftable_reader_options {
  source_info _source;
 
  friend cudftable_reader_options_builder;
 
  explicit cudftable_reader_options(source_info src) : _source{std::move(src)} {}
 
 public:
  static cudftable_reader_options_builder builder(source_info src = source_info{});
 
  [[nodiscard]] source_info const& get_source() const noexcept { return _source; }
 
  void set_source(source_info src) { _source = std::move(src); }
};
 
class cudftable_reader_options_builder {
 public:
  explicit cudftable_reader_options_builder(source_info src) : _options(std::move(src)) {}
 
  [[nodiscard]] cudftable_reader_options build() const { return _options; }
 
 private:
  cudftable_reader_options _options;
};
  // end of io_readers group
 
void write_cudftable(cudftable_writer_options const& options,
                     rmm::cuda_stream_view stream = cudf::get_default_stream());
  // end of group
packed_table read_cudftable(
  cudftable_reader_options const& options,
  rmm::cuda_stream_view stream      = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
  // end of group
}  // namespace io::experimental
}  // namespace CUDF_EXPORT cudf