You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/overview.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ When an asynchronous operation completes it _signals_ its completion by calling
19
19
</details>
20
20
<details>
21
21
<summary>environment</summary>
22
-
The term _enviroment_ refers to the bag of properties associated with an <code>_object_</code> by the call <code><ahref=‘#get-env’>std::execution::get_env</a>(_object_)</code>. By default the environment for objects is empty (<code><ahref=‘#empty-env’>std::execution::empty_env</a></code>). In particular, environments associated with <code><ahref=‘#receiver’>receiver</a></code>s are used to provide access to properties like the <ahref=‘#get-stop-token’>stop token</a>, <ahref=‘#get-scheduler’>scheduler</a>, or <ahref=‘#get-allocator’>allocator</a> associated with the <code><ahref=‘#receiver’>receiver</a></code>. The various properties associated with an object are accessed via <ahref=‘#queries’>queries</a>.
22
+
The term _enviroment_ refers to the bag of properties associated with an <code>_object_</code> by the call <code><ahref=‘#get-env’>std::execution::get_env</a>(_object_)</code>. By default the environment for objects is empty (<code><ahref=‘#env’>std::execution::env<></a></code>). In particular, environments associated with <code><ahref=‘#receiver’>receiver</a></code>s are used to provide access to properties like the <ahref=‘#get-stop-token’>stop token</a>, <ahref=‘#get-scheduler’>scheduler</a>, or <ahref=‘#get-allocator’>allocator</a> associated with the <code><ahref=‘#receiver’>receiver</a></code>. The various properties associated with an object are accessed via <ahref=‘#queries’>queries</a>.
23
23
</details>
24
24
25
25
## Concepts
@@ -70,7 +70,7 @@ Required members for <code>_Receiver_</code>:
70
70
- The type `receiver_concept` is an alias for `receiver_t` or a type derived thereof`.
71
71
- Rvalues of type <code>_Receiver_</code> are movable.
72
72
- Lvalues of type <code>_Receiver_</code> are copyable.
73
-
- <code><a href=‘#get-env’>std::execution::get_env</a>(_receiver_)</code> returns an object. By default this operation returns <code><a href=‘empty-env’>std::execution::empty_env</a></code>.
73
+
- <code><a href=‘#get-env’>std::execution::get_env</a>(_receiver_)</code> returns an object. By default this operation returns <code><a href=‘env’>std::execution::env<></a></code>.
74
74
75
75
Typical members for <code>_Receiver_</code>:
76
76
@@ -177,7 +177,7 @@ Senders represent asynchronous work. They may get composed from multiple senders
177
177
178
178
Requirements for <code>_Sender_</code>:
179
179
- The type <code>_Sender_::sender_concept</code> is an alias for `sender_t` or a type derived thereof or <code>_Sender_</code> is a suitable _awaitable_.
180
-
- <code><a href='get_env'>std::execution::get_env</a>(_sender_)</code> is valid. By default this operation returns <code><a href=‘empty-env’>std::execution::empty_env</a></code>.
180
+
- <code><a href='get_env'>std::execution::get_env</a>(_sender_)</code> is valid. By default this operation returns <code><a href=‘env’>std::execution::env<></a></code>.
181
181
- Rvalues of type <code>_Sender_</code> can be moved.
182
182
- Lvalues of type <code>_Sender_</code> can be copied.
The concept <code>sender_in<<i>Sender, Env</i>></code> tests whether <code>_Sender_</code> is a <code><ahref=‘#sender’>sender</a></code>, <code>_Env_</code> is a destructible type, and <code><ahref=‘#get_completion_signatures’>std::execution::get_completion_signatures</a>(_sender_, _env_)</code> yields a specialization of <code><ahref=‘#completion_signatures’>std::execution::completion_signatures</a></code>.
230
230
</details>
@@ -236,7 +236,7 @@ The concept <code>sender_to<<i>Sender, Receiver</i>></code> tests if <code
236
236
To determine if <code>_Receiver_</code> can receive all <ahref=‘#completion-signals’>completion signals</a> from <code>_Sender_</code> it checks that for each <code>_Signature_</code> in <code><ahref=‘#get_completion_signals’>std::execution::get_completion_signals</a>(_sender_, std::declval<<ahref='#env_of_t'>std::execution::env_of_t</a><_Receiver_>>())</code> the test <code><ahref=‘#receiver_of’>std::execution::receiver_of</a><_Receiver_, _Signature_></code> yields true. To determine if <code>_Sender_</code> can be <code><ahref=‘#connect’>connect</a></code>ed to <code>_Receiver_</code> the concept checks if <code><ahref=‘#connect’>connect</a>(std::declval<_Sender_>(), std::declval<_Receiver_>)</code> is a valid expression.
The concept <code>sends_stopped<<i>Sender, Env</i>></code> determines if <code>_Sender_</code> may send a <code><ahref=‘#set_stopped’>stopped</a></code> <ahref=‘#completion-signals’>completion signal</a>. To do so, the concepts determines if <code><ahref=‘#get_completion_signals’>std::execution::get_completion_signals</a>(_sender_, _env_)</code> contains the signatures <code><ahref=‘#set_stopped’>std::execution::set_stopped_t</a>()</code>.
The expression <code>get_env(<i>queryable</i>)</code> is used to get the environment <code><i>env</i></code> associated with <code><i>queryable</i></code>. To provide a non-default environment for a <code><i>queryable</i></code> a `get_env` member needs to be defined. If <code><i>queryable</i></code> doesn’t provide the <code>get_env</code> query an object of type <code><ahref=‘#empty_env’>empty_env</a></code> is returned.
412
+
The expression <code>get_env(<i>queryable</i>)</code> is used to get the environment <code><i>env</i></code> associated with <code><i>queryable</i></code>. To provide a non-default environment for a <code><i>queryable</i></code> a `get_env` member needs to be defined. If <code><i>queryable</i></code> doesn’t provide the <code>get_env</code> query an object of type <code><ahref=‘#env’>env<></a></code> is returned.
413
413
The value of the expression is <ol>
414
414
<li>the result of <code>as_const(<i>queryable</i>).get_env()</code> if this expression is valid and <code>noexcept</code>.</li>
415
-
<li><code>empty_env</code> otherwise.
415
+
<li><code>env<></code> otherwise.
416
416
</ol>
417
417
<div>
418
418
<details>
@@ -712,7 +712,7 @@ The expression <code>into_variant(<i>sender</i>)</code> creates a sender which t
0 commit comments