R/ConstantFuture-class.R

Defines functions result.ConstantFuture run.ConstantFuture ConstantFuture

Documented in ConstantFuture

#' A future with a constant value
#'
#' A constant future is a future whose expression is a constant
#' and therefore by definition is already resolved upon creation.
#'
#' @inheritParams Future-class
#' 
#' @return
#' `ConstantFuture()` returns an object of class `ConstantFuture`.
#'
#' @export
#' @name ConstantFuture-class
#' @keywords internal
ConstantFuture <- function(..., globals = TRUE, envir = emptyenv()) {
  future <- Future(..., globals = list(), envir = envir)
  t_start <- Sys.time()
  future$result <- FutureResult(
    value = eval(future$expr, envir = envir),
    started = t_start,
    finished = t_start
  )
  future$state <- "finished"
  future <- structure(future, class = c("ConstantFuture", class(future)))
  future
}

#' @export
run.ConstantFuture <- function(future, ...) {
  future
}

#' @export
result.ConstantFuture <- function(future, ...) {
  future$result
}
HenrikBengtsson/future documentation built on April 1, 2024, 3:19 a.m.