| b0661197 |
\name{yield}
\alias{yield}
\alias{yield-methods}
\alias{yield,Streamer-method}
|
| 6744af89 |
\title{Function to yield one task from a Stream or Producer}
|
| b0661197 |
\description{
\code{yield} invoked on a stream yields one chunk of data or, if the
stream is complete, a length zero element of the data. Successive
invocations of \code{yield} produce successive chunks of data.
}
\usage{
yield(x, ...)
}
\arguments{
|
| 4464ce81 |
|
| b0661197 |
\item{x}{A \code{Stream}, \code{Producer}, or \code{Consumer} object.}
|
| 4464ce81 |
|
| b0661197 |
\item{\dots}{Additional arguments, currently unused.}
|
| 4464ce81 |
|
| b0661197 |
}
\value{
A chunk of data, with the specific notion of chunk defined by the
final component of the stream.
}
\author{Martin Morgan \url{mtmorgan@fhcrc.org}}
\seealso{
|
| 4464ce81 |
\code{\link{Stream}}, \code{\linkS4class{Producer}},
|
| b0661197 |
\code{\linkS4class{Consumer}}.
}
|
| 3f24535c |
\examples{
|
| 4464ce81 |
## see example(Stream)
|
| 3f24535c |
}
|
| b0661197 |
\keyword{ manip }
|
