iter8's Introduction

iter8

Iter8 is a small Lua library which provides an iterator object. The interface is heavily inspired by Rust's iterators.

Example

local Iter8 = require "iter8"

for c, n in Iter8.chars("hello"):zip(Iter8.range(5)) do
    print(c .. " is letter number " .. tostring(n))
end

-- Print the primes up to 100
Iter8.range(100):filter(isPrime):foreach(print)

Installation

TODO

Semver

TODO

Documentation

TODO

Contributing

TODO

Running the test suite

TODO

Building the documentation

TODO

iter8's People

Contributors

Watchers

iter8's Issues

Automate test coverage measurement

Generate HTML documentation from LuaLS JSON output

Generate docs (make docs)
Automate doc generation using GitHub Actions

Implement property testing for the test suite

See https://github.com/luc-tielen/lua-quickcheck as a possible library (not up to date)

Support (and add test targets for) other versions of Lua

Add type annotations to all functions

Submit iter8 to luarocks

See https://github.com/luarocks/luarocks/wiki/Creating-a-rock

Host documentation on GitHub Pages

Depends on #2

Support for `nil` as an iterator value (i.e. support for sparse tables)

Some Lua functions are capable of handling nil arguments nicely:

Lua 5.4's table.pack adds a field n to the resulting table, such that the consumer can detect nil values.
select("#", ...) can detect nil arguments being passed.

It's unclear if there's any way to make Iter8 support nil values in this way. Currently, any time an iterator yields nil, the iterator will finish then and there.

If you are reading this, and have a use case for nil values in iterators, feel free to comment what your use case is, and how you'd prefer the semantics to work. If it's possible to implement this in a backwards-compatible way, I would try to do so.

Recommend Projects