Plan: async Iterator

[tmandry]

This is a roadmap item for wg-async. You can view the roadmap here: wg-async roadmap

Write a short doc on the kind of design we expect, and open questions, on this topic (#280).

[tmandry]

Update: Still need to write out how this doesn't block async fn in trait.

Main concerns are around cancel-safety and poll_next vs next, but these shouldn't interact with AFIT.

We also need some discussion of how to migrate to a LendingIterator (supertrait) or GAT-ify the existing Iterator trait. No known interactions with AFIT here.

[yoshuawuyts]

Main concerns are around cancel-safety and poll_next vs next, but these shouldn't interact with AFIT.

I've written an in-depth analysis of how both approaches compare here: https://blog.yoshuawuyts.com/async-iterator-trait. Basing our async traits on AFITs seems like it's clearly the superior direction.

While knowing that basing async iterator on AFITs works well, we also need a strategy for how to integrate it into the stdlib. For that reason we should probably this work on "effect-generic trait declarations". As well as consider not just adding the "async iterator" trait by itself, but re-RFC it to include a full story describing "async iteration".