Skip to content

Commit 43d0cd8

Browse files
committed
fix formatting and add Futures link
1 parent bd22456 commit 43d0cd8

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/src/concepts/futures.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ While computation is a subject to write a whole [book](https://computationbook.c
2828
- they either run to succession and yield a result or they can yield an error
2929
## Deferring computation
3030

31-
As mentioned above `Send` and `Sync` are about data. But programs are not only about data, they also talk about *computing* the data. And that's what \[Futures\][futures] do. We are going to have a close look at how that works in the next chapter. Let's look at what Futures allow us to express, in English. Futures go from this plan:
31+
As mentioned above `Send` and `Sync` are about data. But programs are not only about data, they also talk about *computing* the data. And that's what [`Futures`][futures] do. We are going to have a close look at how that works in the next chapter. Let's look at what Futures allow us to express, in English. Futures go from this plan:
3232

3333
- Do X
3434
- If X succeeds, do Y
@@ -40,6 +40,8 @@ towards
4040

4141
Remember the talk about "deferred computation" in the intro? That's all it is. Instead of telling the computer what to execute and decide upon *now*, you tell it what to start doing and how to react on potential events the... well... `Future`.
4242

43+
[futures]: https://doc.rust-lang.org/std/future/trait.Future.html
44+
4345
## Orienting towards the beginning
4446

4547
Let's have a look at a simple function, specifically the return value:
@@ -77,8 +79,8 @@ What we are searching is something that represents ongoing work towards a result
7779
Ignore `Pin` and `Context` for now, you don't need them for high-level understanding. Looking at it closely, we see the following: it is generic over the `Output`. It provides a function called `poll`, which allows us to check on the state of the current computation.
7880
Every call to `poll()` can result in one of these two cases:
7981

80-
1. The future is done, `poll` will return `[Poll::Ready](https://doc.rust-lang.org/std/task/enum.Poll.html#variant.Ready)`
81-
2. The future has not finished executing, it will return `[Poll::Pending](https://doc.rust-lang.org/std/task/enum.Poll.html#variant.Pending)`
82+
1. The future is done, `poll` will return [`Poll::Ready`](https://doc.rust-lang.org/std/task/enum.Poll.html#variant.Ready)
83+
2. The future has not finished executing, it will return [`Poll::Pending`](https://doc.rust-lang.org/std/task/enum.Poll.html#variant.Pending)
8284

8385
This allows us to externally check if a `Future` has finished doing its work, or is finally done and can give us the value. The most simple way (but not efficient) would be to just constantly poll futures in a loop. There's optimistions here, and this is what a good runtime is does for you.
8486
Note that calling `poll` after case 1 happened may result in confusing behaviour. See the [futures-docs](https://doc.rust-lang.org/std/future/trait.Future.html) for details.

0 commit comments

Comments
 (0)