Generator functions

[azjezz]

Generator functions

[psalm-github-bot]

Hey @azjezz, can you reproduce the issue on https://psalm.dev ?

[azjezz]

e.g :

1. move Psl\Iter\range to Psl\Gen\range
2. add Psl\Iter\range wrapper, which would look like this :

<?php

declare(strict_types=1);

namespace Psl\Iter;

use Psl\Gen;

/**
 * @psalm-template T as numeric
 *
 * @psalm-param T       $start First number (inclusive)
 * @psalm-param T       $end   Last number (inclusive, but doesn't have to be part of
 *                              resulting range if $step steps over it)
 * @psalm-param null|T  $step  Step between numbers (defaults to 1 if $start smaller
 *                              $end and to -1 if $start greater $end)
 *
 * @psalm-return Iterator<int, T>
 *
 * @psalm-pure
 */
function range($start, $end, $step = null): Iterator
{
  return new Iterator(Gen\range($start, $end, $step));
}

[azjezz]

we should probably add Gen\RewindableGenerator::class and Gen\rewindable($generator): RewindableGenerator, currently its possible to create a rewindable + seekable iterator from a generator using Iter\Iterator, however, it would fully exhaust the generator in the constructor, and that would probably have a bad performance impact if the iterator is not used afterwards.