R/s3-vctrs_list_of.R

In constructive: Display Idiomatic Code to Construct Most R Objects

#' Constructive options for class 'data.table'
#'
#' These options will be used on objects of class 'data.table'.
#'
#' Depending on `constructor`, we construct the object as follows:
#' * `"list_of"` (default): Wrap the column definitions in a `list_of()` call.
#' * `"list"` : Use `list()` and treat the class as a regular attribute.
#'
#' @param constructor String. Name of the function used to construct the object, see Details section.
#' @inheritParams opts_atomic
#' @return An object of class <constructive_options/constructive_options_vctrs_list_of>
#' @export
opts_vctrs_list_of <- function(constructor = c("list_of", "next", "list"), ...) {
  .cstr_options("vctrs_list_of", constructor = constructor[[1]], ...)
}

#' @export
#' @method .cstr_construct vctrs_list_of
.cstr_construct.vctrs_list_of <- function(x, ...) {
  opts <- list(...)$opts$vctrs_list_of %||% opts_vctrs_list_of()
  if (is_corrupted_vctrs_list_of(x) || opts$constructor == "next") return(NextMethod())
  UseMethod(".cstr_construct.vctrs_list_of", structure(NA, class = opts$constructor))
}

is_corrupted_vctrs_list_of <- function(x) {
  # TODO
  FALSE
}

#' @export
#' @method .cstr_construct.vctrs_list_of list_of
.cstr_construct.vctrs_list_of.list_of <- function(x, ...) {
  code <- .cstr_apply(
    args = c(as.list(x), list(.ptype = attr(x, "ptype"))),
    fun = "vctrs::list_of",
    ...
  )
  repair_attributes_vctrs_list_of(x, code, ...)
}

#' @export
#' @method .cstr_construct.vctrs_list_of list
.cstr_construct.vctrs_list_of.list <- function(x, ...) {
  .cstr_construct.list(x, ...)
}

repair_attributes_vctrs_list_of <- function(x, code, opts, ..., pipe = NULL) {
  opts <- opts$vctrs_list_of %||% opts_vctrs_list_of()
  if (opts$constructor == "list") {
    return(repair_attributes_list(x, code, ..., pipe = pipe))
  }
  .cstr_repair_attributes(
    x, code, opts = opts, ...,
    pipe = pipe,
    ignore = "ptype",
    idiomatic_class = c("vctrs_list_of", "vctrs_vctr", "list")
  )
}