squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Clarifying documentation for generator

Browse source
This commit is contained in:
Alex Crichton 2017-07-11 07:26:44 -07:00 committed by John Kåre Alsaker
parent e62d9d5230
commit 5d174f0035
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/doc/unstable-book/src/language-features/generators.md
View file

@ -128,14 +128,17 @@ closure-like semantics. Namely:
generator progresses.
* Generator literals produce a value with a unique type which implements the
`std::ops::Generator` trait. This allows actual execution of the genrator
`std::ops::Generator` trait. This allows actual execution of the generator
through the `Generator::resume` method as well as also naming it in return
types and such.
* Traits like `Send` and `Sync` are automatically implemented for a `Generator`
depending on the captured variables of the environment. Note, though, that
generators, like closures, do not implement traits like `Copy` or `Clone`
automatically.
depending on the captured variables of the environment. Unlike closures though
generators also depend on variables live across suspension points. This means
that although the ambient environment may be `Send` or `Sync`, the generator
itself may not be due to internal variables live across `yield` points being
not-`Send` or not-`Sync`. Note, though, that generators, like closures, do
not implement traits like `Copy` or `Clone` automatically.
* Whenever a generator is dropped it will drop all captured environment
variables.