Future ~ Result, Stream ~ Iterator about futures-rs HOT 6 CLOSED

Evidence supporting this: The tutorial, once I read more of it. 😉

The done variant takes a Result<T, E> and returns a Future<Item=T, Error=E>.

and

For streams the equivalent of an "immediately ready" stream is the iter
function which creates a stream that yields the same items as the underlying
iterator.

from futures-rs.

Oh dear, I definitely didn't intend to liken futures to iterators! You're spot on with the issue title, futures are to results as streams are to iterators of results.

I... might shamelessy steal your nifty table! Could you point out though what gave you the impression that futures are to iterators? I'd like to wordsmith those bits specifically.

from futures-rs.

I... might shamelessy steal your nifty table!

Of course! (You might want to leave the nod towards join/zip having different names though, to not confuse readers.)

Could you point out though what gave you the impression that futures are [like] iterators? I'd like to wordsmith those bits specifically.

Sure! Fresh out of TUTORIAL.md:

The Future trait, like Iterator, doesn't specify […]

The combinators are designed to be very similar to the Iterator combinators. That is, they all consume the receiving future and return a new future.

Usage of the combinators should feel very similar to the Iterator trait in Rust […]

[…] return a Future! Like with the Iterator trait, however, this isn't […]

Okay, I admit, I just searched for "Iterator" in that file and quoted the first few results! 😉 But you can see that it's not just search/replace as you are talking about properties of Iterator (consume, returning the trait).

from futures-rs.

Aha! To the word smithy!

from futures-rs.

word smithy!

May I suggest you use 'forge' instead?

from futures-rs.

Ok, I've bolstered the Stream section which should hopefully address this!

from futures-rs.