as_iterator: Transform an object to an iterator

View source: R/iterator.R

as_iteratorR Documentation

Transform an object to an iterator

Description

as_iterator() is a generic function that transforms its input to an iterator function. The default implementation is as follows:

  • Functions are returned as is.

  • Other objects are assumed to be vectors with length() and [[ methods.

Methods must return functions that implement coro's iterator protocol.

as_iterator() is called by coro on the RHS of ⁠in⁠ in for loops. This applies within generators, async functions, and loop().

Usage

as_iterator(x)

## Default S3 method:
as_iterator(x)

Arguments

x

An object.

Value

An iterable function.

Examples

as_iterator(1:3)

i <- as_iterator(1:3)
loop(for (x in i) print(x))

coro documentation built on Oct. 16, 2024, 1:09 a.m.