Home Explore Help
Sign In
RONCC
/
HPC-Tools-for-Quantum-Computing
Watch 1
Star 0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: e971e022d2
Branches Tags
HPC-Tools-fo...
/
doc
/
ocl
/
async
/
index.html

index.html 11 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136 
  1. <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `async` mod in crate `ocl`."><meta name="keywords" content="rust, rustlang, rust-lang, async"><title>ocl::async - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><p class='location'>Module async</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'async', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>ocl</a>::<wbr><a class="mod" href=''>async</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/ocl/async/mod.rs.html#1-18' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Types related to futures and asynchrony.</p>
    2. 

  2. </div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
    3. 

  3. <table>
    4. 

  4.                        <tr class=' module-item'>
    5. 

  5.                            <td><a class="struct" href="struct.BufferSink.html"
    6. 

  6.                                   title='struct ocl::async::BufferSink'>BufferSink</a></td>
    7. 

  7.                            <td class='docblock-short'>
    8. 

  8.                                 <p>Represents mapped memory and allows frames of data to be 'flushed'
    9. 

  9. (written) from host-accessible mapped memory region into its associated
    10. 

  10. device-visible buffer in a repeated fashion.</p>
    11. 

  11. 

  12.                            </td>
    13. 

  13.                        </tr>
    14. 

  14.                        <tr class=' module-item'>
    15. 

  15.                            <td><a class="struct" href="struct.BufferSinkInner.html"
    16. 

  16.                                   title='struct ocl::async::BufferSinkInner'>BufferSinkInner</a></td>
    17. 

  17.                            <td class='docblock-short'>
    18. 

  18.                                 
    19. 

  19.                            </td>
    20. 

  20.                        </tr>
    21. 

  21.                        <tr class=' module-item'>
    22. 

  22.                            <td><a class="struct" href="struct.BufferStream.html"
    23. 

  23.                                   title='struct ocl::async::BufferStream'>BufferStream</a></td>
    24. 

  24.                            <td class='docblock-short'>
    25. 

  25.                                 <p>Represents mapped memory and allows frames of data to be 'flooded' (read)
    26. 

  26. from a device-visible <code>Buffer</code> into its associated host-accessible mapped
    27. 

  27. memory region in a repeated fashion.</p>
    28. 

  28. 

  29.                            </td>
    30. 

  30.                        </tr>
    31. 

  31.                        <tr class=' module-item'>
    32. 

  32.                            <td><a class="struct" href="struct.BufferStreamInner.html"
    33. 

  33.                                   title='struct ocl::async::BufferStreamInner'>BufferStreamInner</a></td>
    34. 

  34.                            <td class='docblock-short'>
    35. 

  35.                                 
    36. 

  36.                            </td>
    37. 

  37.                        </tr>
    38. 

  38.                        <tr class=' module-item'>
    39. 

  39.                            <td><a class="struct" href="struct.FutureFlood.html"
    40. 

  40.                                   title='struct ocl::async::FutureFlood'>FutureFlood</a></td>
    41. 

  41.                            <td class='docblock-short'>
    42. 

  42.                                 
    43. 

  43.                            </td>
    44. 

  44.                        </tr>
    45. 

  45.                        <tr class=' module-item'>
    46. 

  46.                            <td><a class="struct" href="struct.FutureFlush.html"
    47. 

  47.                                   title='struct ocl::async::FutureFlush'>FutureFlush</a></td>
    48. 

  48.                            <td class='docblock-short'>
    49. 

  49.                                 
    50. 

  50.                            </td>
    51. 

  51.                        </tr>
    52. 

  52.                        <tr class=' module-item'>
    53. 

  53.                            <td><a class="struct" href="struct.FutureGuard.html"
    54. 

  54.                                   title='struct ocl::async::FutureGuard'>FutureGuard</a></td>
    55. 

  55.                            <td class='docblock-short'>
    56. 

  56.                                 <p>A future that resolves to a read or write guard after ensuring that the
    57. 

  57. data being guarded is appropriately locked during the execution of an
    58. 

  58. OpenCL command.</p>
    59. 

  59. 

  60.                            </td>
    61. 

  61.                        </tr>
    62. 

  62.                        <tr class=' module-item'>
    63. 

  63.                            <td><a class="struct" href="struct.FutureMemMap.html"
    64. 

  64.                                   title='struct ocl::async::FutureMemMap'>FutureMemMap</a></td>
    65. 

  65.                            <td class='docblock-short'>
    66. 

  66.                                 <p>A future which resolves to a <code>MemMap</code> as soon as its creating command
    67. 

  67. completes.</p>
    68. 

  68. 

  69.                            </td>
    70. 

  70.                        </tr>
    71. 

  71.                        <tr class=' module-item'>
    72. 

  72.                            <td><a class="struct" href="struct.MemMap.html"
    73. 

  73.                                   title='struct ocl::async::MemMap'>MemMap</a></td>
    74. 

  74.                            <td class='docblock-short'>
    75. 

  75.                                 <p>A view of memory mapped by <code>clEnqueueMap{...}</code>.</p>
    76. 

  76. 

  77.                            </td>
    78. 

  78.                        </tr>
    79. 

  79.                        <tr class=' module-item'>
    80. 

  80.                            <td><a class="struct" href="struct.OrderLock.html"
    81. 

  81.                                   title='struct ocl::async::OrderLock'>OrderLock</a></td>
    82. 

  82.                            <td class='docblock-short'>
    83. 

  83.                                 <p>A lock with conserved global order which interoperates with OpenCL events
    84. 

  84. and Rust futures to provide exclusive access to data.</p>
    85. 

  85. 

  86.                            </td>
    87. 

  87.                        </tr>
    88. 

  88.                        <tr class=' module-item'>
    89. 

  89.                            <td><a class="struct" href="struct.ReadGuard.html"
    90. 

  90.                                   title='struct ocl::async::ReadGuard'>ReadGuard</a></td>
    91. 

  91.                            <td class='docblock-short'>
    92. 

  92.                                 <p>Allows access to the data contained within a lock just like a mutex guard.</p>
    93. 

  93. 

  94.                            </td>
    95. 

  95.                        </tr>
    96. 

  96.                        <tr class=' module-item'>
    97. 

  97.                            <td><a class="struct" href="struct.RwVec.html"
    98. 

  98.                                   title='struct ocl::async::RwVec'>RwVec</a></td>
    99. 

  99.                            <td class='docblock-short'>
    100. 

  100.                                 <p>A locking <code>Vec</code> which interoperates with OpenCL events and Rust futures to
    101. 

  101. provide exclusive access to data.</p>
    102. 

  102. 

  103.                            </td>
    104. 

  104.                        </tr>
    105. 

  105.                        <tr class=' module-item'>
    106. 

  106.                            <td><a class="struct" href="struct.WriteGuard.html"
    107. 

  107.                                   title='struct ocl::async::WriteGuard'>WriteGuard</a></td>
    108. 

  108.                            <td class='docblock-short'>
    109. 

  109.                                 <p>Allows access to the data contained within just like a mutex guard.</p>
    110. 

  110. 

  111.                            </td>
    112. 

  112.                        </tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
    113. 

  113. <table>
    114. 

  114.                        <tr class=' module-item'>
    115. 

  115.                            <td><a class="trait" href="trait.OrderGuard.html"
    116. 

  116.                                   title='trait ocl::async::OrderGuard'>OrderGuard</a></td>
    117. 

  117.                            <td class='docblock-short'>
    118. 

  118.                                 <p>A read or write guard for an <code>OrderLock</code>.</p>
    119. 

  119. 

  120.                            </td>
    121. 

  121.                        </tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
    122. 

  122. <table>
    123. 

  123.                        <tr class=' module-item'>
    124. 

  124.                            <td><a class="type" href="type.FutureReadGuard.html"
    125. 

  125.                                   title='type ocl::async::FutureReadGuard'>FutureReadGuard</a></td>
    126. 

  126.                            <td class='docblock-short'>
    127. 

  127.                                 
    128. 

  128.                            </td>
    129. 

  129.                        </tr>
    130. 

  130.                        <tr class=' module-item'>
    131. 

  131.                            <td><a class="type" href="type.FutureWriteGuard.html"
    132. 

  132.                                   title='type ocl::async::FutureWriteGuard'>FutureWriteGuard</a></td>
    133. 

  133.                            <td class='docblock-short'>
    134. 

  134.                                 
    135. 

  135.                            </td>
    136. 

  136.                        </tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "ocl";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
    137.