FutureResult: Results from resolving a future

Description Usage Arguments Details Value Note to developers

View source: R/FutureResult-class.R

Description

Results from resolving a future

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
FutureResult(
  value = NULL,
  visible = TRUE,
  stdout = NULL,
  conditions = NULL,
  rng = FALSE,
  ...,
  started = .POSIXct(NA_real_),
  finished = Sys.time(),
  version = "1.8"
)

## S3 method for class 'FutureResult'
as.character(x, ...)

## S3 method for class 'FutureResult'
print(x, ...)

Arguments

value

The value of the future expression. If the expression was not fully resolved (e.g. an error) occurred, the the value is NULL.

visible

If TRUE, the value was visible, otherwise invisible.

conditions

A list of zero or more list elements each containing a captured condition and possibly more meta data such as the call stack and a timestamp.

rng

If TRUE, the .Random.seed was updated from resolving the future, otherwise not.

...

(optional) Additional named results to be returned.

started, finished

POSIXct timestamps when the evaluation of the future expression was started and finished.

version

The version format of the results.

Details

This function is only part of the backend Future API. This function is not part of the frontend Future API.

Value

An object of class FutureResult.

Note to developers

The FutureResult structure is under development and may change at anytime, e.g. elements may be renamed or removed. Because of this, please avoid accessing the elements directly in code. Feel free to reach out if you need to do so in your code.


future documentation built on Jan. 8, 2021, 5:36 p.m.

Related to FutureResult in future...