R/table_streamer.R

In fstpackage/syntheticbench: Synthetic dataset creation and serialization benchmarks

#  synthetic - R package for synthetic dataset creation and serialization benchmarks
#
#  Copyright (C) 2019-present, Mark AJ Klik
#
#  This file is part of the synthetic R package.
#
#  The synthetic R package is free software: you can redistribute it and/or modify it
#  under the terms of the GNU Affero General Public License version 3 as
#  published by the Free Software Foundation.
#
#  The synthetic R package is distributed in the hope that it will be useful, but
#  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
#  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
#  for more details.
#
#  You should have received a copy of the GNU Affero General Public License along
#  with the synthetic R package. If not, see <http://www.gnu.org/licenses/>.
#
#  You can contact the author at:
#  - synthetic R package source repository : https://github.com/fstpackage/synthetic


#' Define an object of class 'tablestreamer' that defines specific methods for
#' serializing of datasets
#'
#' @param id ID of the table streamer (e.g. 'fst' or 'parguet')
#' @param table_writer method for writing with signature
#' f(x, file_name, compress, threads, custom_parameters). Parameter compression should be a percentage
#' (0.0 to 100.0).
#' @param table_reader method for reading with signature f(file_name, threads, custom_parameters).
#' @param can_select_threads TRUE of FALSE depending on the ability to select the number of threads
#' @param variable_compression TRUE of FALSE depending on the ability to select compression
#' @param set_threads method for specifying the number of threads to use for (de-) serialization, the
#' signature must be f(nr_of_threads, custom_parameters).
#' @param custom_parameters Additional parameters that are needed for the streamer
#'
#' @return a tablestreamer object
#' @export
table_streamer <- function(id, table_writer, table_reader, can_select_threads = FALSE, variable_compression = FALSE,
  set_threads = NULL, custom_parameters = NULL) {
  x <- list(
    id = id,
    table_writer = table_writer,
    table_reader = table_reader,
    set_threads = set_threads,
    can_select_threads = can_select_threads,
    variable_compression = variable_compression,
    custom_parameters
  )

  class(x) <- "tablestreamer"

  x
}