mirai (version 2.2.0)

as.promise.mirai_map: Make mirai_map Promise

Description

Creates a 'promise' from a 'mirai_map'.

Usage

# S3 method for mirai_map
as.promise(x)

Value

A 'promise' object.

Arguments

x

an object of class 'mirai_map'.

Details

This function is an S3 method for the generic as.promise() for class 'mirai_map'.

Requires the promises package.

Allows a 'mirai_map' to be used with the promise pipe %...>%, which schedules a function to run upon resolution of the entire 'mirai_map'.

The implementation internally uses promises::promise_all(). If all of the promises were successful, the returned promise will resolve to a list of the promise values; if any promise fails, the first error to be encountered will be used to reject the returned promise.

Examples

if (FALSE) { # interactive() && requireNamespace("promises", quietly = TRUE)
library(promises)

with(daemons(1), {
  mp <- mirai_map(1:3, function(x) { Sys.sleep(1); x })
  p <- as.promise(mp)
  print(p)
  p %...>% print
  mp[.flat]
})
}