File: futures.Rd

package info (click to toggle)
r-cran-future 1.21.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,544 kB
  • sloc: sh: 14; makefile: 2
file content (28 lines) | stat: -rw-r--r-- 775 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/futures.R
\name{futures}
\alias{futures}
\title{Get all futures in a container}
\usage{
futures(x, ...)
}
\arguments{
\item{x}{An environment, a list, or a list environment.}

\item{\dots}{Not used.}
}
\value{
An object of same type as \code{x} and with the same names
and/or dimensions, if set.
}
\description{
Gets all futures in an environment, a list, or a list environment
and returns an object of the same class (and dimensions).
Non-future elements are returned as is.
}
\details{
This function is useful for retrieve futures that were created via
future assignments (\verb{\%<-\%}) and therefore stored as promises.
This function turns such promises into standard \code{Future}
objects.
}