Skip to content

Commit 88fa1de

Browse files
kammcelibhal-bot
kammce
and
libhal-bot
authored
Add async_context main API documentation (#41)
Co-authored-by: libhal-bot <libhal-bot@users.noreply.github.com>
1 parent d49fff7 commit 88fa1de

10 files changed

Lines changed: 1029 additions & 68 deletions

File tree

‎async_context/main/.doctrees/api/async_context.doctree‎

245 KB
Binary file not shown.

‎async_context/main/.doctrees/environment.pickle‎

114 KB
Binary file not shown.

‎async_context/main/.doctrees/index.doctree‎

-14 Bytes
Binary file not shown.

‎async_context/main/_sources/index.rst.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
async_context API documentation
2-
=======================================
2+
==================================
33

44
**Welcome to async_context API documentation**
55

@@ -10,6 +10,6 @@ performance.
1010

1111
.. toctree::
1212
:caption: async_context Docs
13-
:maxdepth: 5
13+
:maxdepth: 4
1414

15-
async_context API <api/index>
15+
api/async_context

‎async_context/main/api/async_context.html‎

Lines changed: 814 additions & 41 deletions
Large diffs are not rendered by default.

‎async_context/main/genindex.html‎

Lines changed: 111 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -227,8 +227,8 @@
227227
<ul class="bd-navbar-elements navbar-nav">
228228

229229
<li class="nav-item ">
230-
<a class="nav-link nav-internal" href="api/index.html">
231-
async_context API
230+
<a class="nav-link nav-internal" href="api/async_context.html">
231+
async_context
232232
</a>
233233
</li>
234234

@@ -315,8 +315,8 @@
315315
<ul class="bd-navbar-elements navbar-nav">
316316

317317
<li class="nav-item ">
318-
<a class="nav-link nav-internal" href="api/index.html">
319-
async_context API
318+
<a class="nav-link nav-internal" href="api/async_context.html">
319+
async_context
320320
</a>
321321
</li>
322322

@@ -362,8 +362,115 @@
362362
<h1 id="index">Index</h1>
363363

364364
<div class="genindex-jumpbox">
365+
<a href="#V"><strong>V</strong></a>
365366

366367
</div>
368+
<h2 id="V">V</h2>
369+
<table style="width: 100%" class="indextable genindextable"><tr>
370+
<td style="width: 33%; vertical-align: top;"><ul>
371+
<li><a href="api/async_context.html#_CPPv4I_6size_tEN2v013basic_contextE">v0::basic_context (C++ class)</a>
372+
</li>
373+
<li><a href="api/async_context.html#_CPPv4N2v010blocked_byE">v0::blocked_by (C++ enum)</a>
374+
</li>
375+
<li><a href="api/async_context.html#_CPPv4N2v010blocked_by8externalE">v0::blocked_by::external (C++ enumerator)</a>
376+
</li>
377+
<li><a href="api/async_context.html#_CPPv4N2v010blocked_by2ioE">v0::blocked_by::io (C++ enumerator)</a>
378+
</li>
379+
<li><a href="api/async_context.html#_CPPv4N2v010blocked_by7nothingE">v0::blocked_by::nothing (C++ enumerator)</a>
380+
</li>
381+
<li><a href="api/async_context.html#_CPPv4N2v010blocked_by4syncE">v0::blocked_by::sync (C++ enumerator)</a>
382+
</li>
383+
<li><a href="api/async_context.html#_CPPv4N2v010blocked_by4timeE">v0::blocked_by::time (C++ enumerator)</a>
384+
</li>
385+
<li><a href="api/async_context.html#_CPPv4N2v07contextE">v0::context (C++ class)</a>
386+
</li>
387+
<li><a href="api/async_context.html#_CPPv4NK2v07context13active_handleEv">v0::context::active_handle (C++ function)</a>
388+
</li>
389+
<li><a href="api/async_context.html#_CPPv4N2v07context17block_by_externalEv">v0::context::block_by_external (C++ function)</a>
390+
</li>
391+
<li><a href="api/async_context.html#_CPPv4N2v07context11block_by_ioE14sleep_duration">v0::context::block_by_io (C++ function)</a>
392+
</li>
393+
<li><a href="api/async_context.html#_CPPv4N2v07context13block_by_syncEP7context">v0::context::block_by_sync (C++ function)</a>
394+
</li>
395+
<li><a href="api/async_context.html#_CPPv4N2v07context13block_by_timeE14sleep_duration">v0::context::block_by_time (C++ function)</a>
396+
</li>
397+
<li><a href="api/async_context.html#_CPPv4N2v07context6cancelEv">v0::context::cancel (C++ function)</a>
398+
</li>
399+
<li><a href="api/async_context.html#_CPPv4NK2v07context8capacityEv">v0::context::capacity (C++ function)</a>
400+
</li>
401+
<li><a href="api/async_context.html#_CPPv4N2v07context7contextERK7context">v0::context::context (C++ function)</a>, <a href="api/async_context.html#_CPPv4N2v07context7contextERR7context">[1]</a>, <a href="api/async_context.html#_CPPv4N2v07context7contextEv">[2]</a>
402+
</li>
403+
<li><a href="api/async_context.html#_CPPv4N2v07context4doneEv">v0::context::done (C++ function)</a>
404+
</li>
405+
<li><a href="api/async_context.html#_CPPv4N2v07context23initialize_stack_memoryENSt4spanI4uptrEE">v0::context::initialize_stack_memory (C++ function)</a>
406+
</li>
407+
<li><a href="api/async_context.html#_CPPv4NK2v07context16memory_remainingEv">v0::context::memory_remaining (C++ function)</a>
408+
</li>
409+
<li><a href="api/async_context.html#_CPPv4NK2v07context11memory_usedEv">v0::context::memory_used (C++ function)</a>
410+
</li>
411+
<li><a href="api/async_context.html#_CPPv4N2v07contextaSERK7context">v0::context::operator= (C++ function)</a>, <a href="api/async_context.html#_CPPv4N2v07contextaSERR7context">[1]</a>
412+
</li>
413+
<li><a href="api/async_context.html#_CPPv4N2v07context6resumeEv">v0::context::resume (C++ function)</a>
414+
</li>
415+
<li><a href="api/async_context.html#_CPPv4NK2v07context5stateEv">v0::context::state (C++ function)</a>
416+
</li>
417+
<li><a href="api/async_context.html#_CPPv4N2v07context7unblockEv">v0::context::unblock (C++ function)</a>
418+
</li>
419+
</ul></td>
420+
<td style="width: 33%; vertical-align: top;"><ul>
421+
<li><a href="api/async_context.html#_CPPv4N2v07context28unblock_without_notificationEv">v0::context::unblock_without_notification (C++ function)</a>
422+
</li>
423+
<li><a href="api/async_context.html#_CPPv4N2v07contextD0Ev">v0::context::~context (C++ function)</a>
424+
</li>
425+
<li><a href="api/async_context.html#_CPPv4N2v016exclusive_accessE">v0::exclusive_access (C++ class)</a>
426+
</li>
427+
<li><a href="api/async_context.html#_CPPv4NK2v016exclusive_access7addressEv">v0::exclusive_access::address (C++ function)</a>
428+
</li>
429+
<li><a href="api/async_context.html#_CPPv4N2v016exclusive_access16exclusive_accessER7context">v0::exclusive_access::exclusive_access (C++ function)</a>, <a href="api/async_context.html#_CPPv4N2v016exclusive_access16exclusive_accessERK16exclusive_access">[1]</a>, <a href="api/async_context.html#_CPPv4N2v016exclusive_access16exclusive_accessERR16exclusive_access">[2]</a>, <a href="api/async_context.html#_CPPv4N2v016exclusive_access16exclusive_accessEv">[3]</a>
430+
</li>
431+
<li><a href="api/async_context.html#_CPPv4NK2v016exclusive_access6in_useEv">v0::exclusive_access::in_use (C++ function)</a>
432+
</li>
433+
<li><a href="api/async_context.html#_CPPv4NK2v016exclusive_accesscvbEv">v0::exclusive_access::operator bool (C++ function)</a>
434+
</li>
435+
<li><a href="api/async_context.html#_CPPv4N2v016exclusive_accessaSE9nullptr_t">v0::exclusive_access::operator= (C++ function)</a>, <a href="api/async_context.html#_CPPv4N2v016exclusive_accessaSER16exclusive_access">[1]</a>, <a href="api/async_context.html#_CPPv4N2v016exclusive_accessaSER7context">[2]</a>, <a href="api/async_context.html#_CPPv4N2v016exclusive_accessaSERK16exclusive_access">[3]</a>
436+
</li>
437+
<li><a href="api/async_context.html#_CPPv4N2v016exclusive_accesseqER7context">v0::exclusive_access::operator== (C++ function)</a>
438+
</li>
439+
<li><a href="api/async_context.html#_CPPv4N2v016exclusive_access20set_as_block_by_syncER7context">v0::exclusive_access::set_as_block_by_sync (C++ function)</a>
440+
</li>
441+
<li><a href="api/async_context.html#_CPPv4N2v016exclusive_access17unblock_and_clearEv">v0::exclusive_access::unblock_and_clear (C++ function)</a>
442+
</li>
443+
<li><a href="api/async_context.html#_CPPv4I0EN2v06futureE">v0::future (C++ class)</a>
444+
</li>
445+
<li><a href="api/async_context.html#_CPPv4N2v06future7awaiterE">v0::future::awaiter (C++ struct)</a>
446+
</li>
447+
<li><a href="api/async_context.html#_CPPv4NK2v06future4doneEv">v0::future::done (C++ function)</a>
448+
</li>
449+
<li><a href="api/async_context.html#_CPPv4I0EN2v06future6futureERR1U">v0::future::future (C++ function)</a>, <a href="api/async_context.html#_CPPv4N2v06future6futureERR6future">[1]</a>, <a href="api/async_context.html#_CPPv4N2v06future6futureEv">[2]</a>
450+
</li>
451+
<li><a href="api/async_context.html#_CPPv4NK2v06future9has_valueEv">v0::future::has_value (C++ function)</a>
452+
</li>
453+
<li><a href="api/async_context.html#_CPPv4N2v06futurecv8co_awaitEv">v0::future::operator co_await (C++ function)</a>
454+
</li>
455+
<li><a href="api/async_context.html#_CPPv4N2v06futureaSERR6future">v0::future::operator= (C++ function)</a>
456+
</li>
457+
<li><a href="api/async_context.html#_CPPv4N2v06future5valueEv">v0::future::value (C++ function)</a>
458+
</li>
459+
<li><a href="api/async_context.html#_CPPv4N2v06futureD0Ev">v0::future::~future (C++ function)</a>
460+
</li>
461+
<li><a href="api/async_context.html#_CPPv4N2v013proxy_contextE">v0::proxy_context (C++ class)</a>
462+
</li>
463+
<li><a href="api/async_context.html#_CPPv4N2v013proxy_context4fromER7context">v0::proxy_context::from (C++ function)</a>
464+
</li>
465+
<li><a href="api/async_context.html#_CPPv4N2v013proxy_contextaSERK13proxy_context">v0::proxy_context::operator= (C++ function)</a>, <a href="api/async_context.html#_CPPv4N2v013proxy_contextaSERR13proxy_context">[1]</a>
466+
</li>
467+
<li><a href="api/async_context.html#_CPPv4N2v013proxy_context13proxy_contextERK13proxy_context">v0::proxy_context::proxy_context (C++ function)</a>, <a href="api/async_context.html#_CPPv4N2v013proxy_context13proxy_contextERR13proxy_context">[1]</a>
468+
</li>
469+
<li><a href="api/async_context.html#_CPPv4N2v013proxy_contextD0Ev">v0::proxy_context::~proxy_context (C++ function)</a>
470+
</li>
471+
</ul></td>
472+
</tr></table>
473+
367474

368475

369476
</article>

0 commit comments

Comments
 (0)