update api_reference.md Index

* add anchors * add missing items
facebookexperimental · May 10, 2023 · fc74639 · fc74639
1 parent 98bd454
commit fc74639
Showing 1 changed file with 89 additions and 84 deletions.
diff --git a/doc/api_reference.md b/doc/api_reference.md
@@ -1,89 +1,94 @@
 # Index
 
-* Receiver Queries
-  * `get_stop_token()`
-  * `get_scheduler()`
-  * `get_allocator()`
-  * `get_execution_policy()`
-* Sender Factories
-  * `create`
-  * `just()`
-  * `just_done()` / `stop()`
-  * `just_error()`
-  * `just_void_or_done()`
-  * `stop_if_requested()`
-* Sender Algorithms
-  * `detach_on_cancel()`
-  * `then()`
-  * `finally()`
-  * `via()`
-  * `typed_via()`
-  * `on()`
-  * `let_value()`
-  * `let_error()`
-  * `let_done()`
-  * `let_value_with()`
-  * `let_value_with_stop_source()`
-  * `let_value_with_stop_token()`
-  * `sequence()`
-  * `sync_wait()`
-  * `when_all()`
-  * `materialize()`
-  * `dematerialize()`
-  * `repeat_effect_until()`
-  * `repeat_effect()`
-  * `retry_when()`
-  * `stop_when()`
-  * `allocate()`
-  * `with_query_value()`
-  * `with_allocator()`
-  * `done_as_optional()`
-  * `nest()`
-* Sender Types
-  * `async_trace_sender`
-* Sender Queries
-  * `blocking()`
-* Many Sender Algorithms
-  * `bulk_transform()`
-  * `bulk_join()`
-  * `bulk_schedule()`
-* Stream Algorithms
-  * `adapt_stream()`
-  * `next_adapt_stream()`
-  * `reduce_stream()`
-  * `for_each()`
-  * `transform_stream()`
-  * `via_stream()`
-  * `typed_via_stream()`
-  * `on_stream()`
-  * `type_erase<Ts...>()`
-  * `take_until()`
-  * `single()`
-  * `stop_immediately()`
-  * `delay()`
-* Stream Types
-  * `range_stream`
-  * `type_erased_stream<Ts...>`
-  * `never_stream`
-* Scheduler Types
-  * `inline_scheduler`
-  * `single_thread_context`
-  * `trampoline_scheduler`
-  * `timed_single_thread_context`
-  * `thread_unsafe_event_loop`
-  * `new_thread_context`
-  * `linux::io_uring_context`
-* StopToken Types
-  * `unstoppable_token`
-  * `inplace_stop_token` / `inplace_stop_source`
-* Synchronisation Primitives
-  * `async_manual_reset_event`
-  * `async_mutex`
-* Coroutine support
-  * `task`
-  * `at_coroutine_exit`
-* Other
-  * `async_scope`
+* [Receiver Queries](#receiver-queries)
+  * [`get_scheduler()`](#get_schedulerreceiver)
+  * [`get_allocator()`](#get_allocatorreceiver)
+  * [`get_stop_token()`](#get_stop_tokenreceiver)
+  * [`get_execution_policy()`](#get_execution_policymanyreceiver)
+* [Sender Factories](#sender-factories)
+  * [`create()`](#createvaluetypescallable)
+  * [`just()`](#justargs)
+  * [`just_done()` / `stop()`](#just_done--stop)
+  * [`just_error()`](#just_errore)
+  * [`just_void_or_done()`](#just_void_or_doneisvoid)
+  * [`just_from()`](#just_fromcallable)
+  * [`stop_if_requested()`](#stop_if_requested)
+  * [`defer()`](#defercallable)
+* [Sender Algorithms](#sender-algorithms)
+  * [`detach_on_cancel()`](#detach_on_cancelsender-sender---sender)
+  * [`then()`](#thensender-predecessor-func-func---sender)
+  * [`let_value()`](#let_valuesender-pred-invocable-func---sender)
+  * [`let_error()`](#let_errorsender-predecessor-func-func---sender)
+  * [`let_done()`](#let_donesender-predecessor-func-func---sender)
+  * [`let_value_with()`](#let_value_withinvocable-state_factory-invocable-func---sender)
+  * [`let_value_with_stop_source()`](#let_value_with_stop_sourceinvocable-func---sender)
+  * [`let_value_with_stop_token()`](#let_value_with_stop_tokeninvocable-func---sender)
+  * [`finally()`](#finallysender-source-sender-completion---sender)
+  * [`via()`](#viascheduler-scheduler-sender-sender---sender)
+  * [`typed_via()`](#typed_viasender-source-scheduler-scheduler---sender)
+  * [`on()`](#onscheduler-scheduler-sender-sender---sender)
+  * [`sequence()`](#sequencesender-predecessors-sender-last---sender)
+  * [`sync_wait()`](#sync_waitsender-sender---stdoptionalresult)
+  * [`when_all()`](#when_allsenders---sender)
+  * [`materialize()`](#materializesender-sender---sender)
+  * [`dematerialize()`](#dematerializesender-sender---sender)
+  * [`repeat_effect_until()`](#repeat_effect_untilsender-source-invocable-predicate---sender)
+  * [`repeat_effect()`](#repeat_effectsender-source---sender)
+  * [`retry_when()`](#retry_whensender-source-invocableerror-handler---sender)
+  * [`stop_when()`](#stop_whensender-source-sender-trigger---sender)
+  * [`allocate()`](#allocatesender-sender---sender)
+  * [`with_query_value()`](#with_query_valuesender-sender-cpo-cpo-t-value---sender)
+  * [`with_allocator()`](#with_allocatorsender-sender-allocator-allocator---allocator)
+  * [`done_as_optional()`](#done_as_optionalsender-sender---sender)
+  * [`nest()`](#nestsender-sender-scope-scope---sender)
+* [Sender Types](#sender-types)
+  * [`async_trace_sender`](#async_trace_sender)
+* [Sender Queries](#sender-queries)
+  * [`blocking()`](#blockingconst-sender---blocking_kind)
+* [Many Sender Algorithms](#many-sender-algorithms)
+  * [`bulk_transform()`](#bulk_transformmanysender-sender-func-func-funcpolicy-policy---manysender)
+  * [`bulk_join()`](#bulk_joinmanysender-source---sender)
+  * [`bulk_schedule()`](#bulk_schedulescheduler-sched-count-n---manysender)
+* [Stream Algorithms](#stream-algorithms)
+  * [`adapt_stream()`](#adapt_streamstream-stream-func-adaptor---stream)
+  * [`next_adapt_stream()`](#next_adapt_streamstream-stream-func-adaptor---stream)
+  * [`reduce_stream()`](#reduce_streamstream-stream-t-initialstate-func-reducer---sendert)
+  * [`for_each()`](#for_eachstream-stream-func-func---sendervoid)
+  * [`transform_stream()`](#transform_streamstream-stream-func-func---stream)
+  * [`via_stream()`](#via_streamscheduler-scheduler-stream-stream---stream)
+  * [`typed_via_stream()`](#typed_via_streamscheduler-scheduler-stream-stream---stream)
+  * [`on_stream()`](#on_streamscheduler-scheduler-stream-stream---stream)
+  * [`type_erase<Ts...>()`](#type_erasetsstream-stream---type_erased_streamts)
+  * [`take_until()`](#take_untilstream-source-stream-trigger---stream)
+  * [`single()`](#singlesender-sender---stream)
+  * [`stop_immediately()`](#stop_immediatelytsstream-stream---stream)
+  * [`delay()`](#delaystream-stream-timescheduler-scheduler-duration-d---stream)
+* [Stream Types](#stream-types)
+  * [`range_stream`](#range_stream)
+  * [`type_erased_stream<Ts...>`](#type_erased_streamts)
+  * [`never_stream`](#never_stream)
+* [Scheduler Algorithms](#scheduler-algorithms)
+  * [`schedule()`](#schedulescheduler-schedule---senderofvoid)
+* [Scheduler Types](#scheduler-types)
+  * [`inline_scheduler`](#inline_scheduler)
+  * [`single_thread_context`](#single_thread_context)
+  * [`trampoline_scheduler`](#trampoline_scheduler)
+  * [`timed_single_thread_context`](#timed_single_thread_context)
+  * [`thread_unsafe_event_loop`](#thread_unsafe_event_loop)
+  * [`new_thread_context`](#new_thread_context)
+  * [`linux::io_uring_context`](#linuxio_uring_context)
+* [StopToken Types](#stoptoken-types)
+  * [`unstoppable_token`](#unstoppable_token)
+  * [`inplace_stop_token` / `inplace_stop_source`](#inplace_stop_token-and-inplace_stop_source)
+* [Synchronisation Primitives](#synchronisation-primitives)
+  * [`async_manual_reset_event`](#async_manual_reset_event)
+  * [`async_mutex`](#async_mutex)
+* [Coroutine support](#coroutine-support)
+  * [`task`](#task)
+  * [`at_coroutine_exit`](#at_coroutine_exit)
+* [Other](#other)
+  * [`async_scope`](#async_scope)
+  * [`variant_sender`](#variant_sender)
 
 # Receiver Queries