RONCC
/
HPC-Tools-for-Quantum-Computing


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262
							<!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="../../main.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">
            </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>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.BufferSink.html"
                                  title='struct ocl::async::BufferSink'>BufferSink</a></td>
                           <td class='docblock-short'>
                                <p>Represents mapped memory and allows frames of data to be 'flushed'
(written) from host-accessible mapped memory region into its associated
device-visible buffer in a repeated fashion.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.BufferSinkInner.html"
                                  title='struct ocl::async::BufferSinkInner'>BufferSinkInner</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.BufferStream.html"
                                  title='struct ocl::async::BufferStream'>BufferStream</a></td>
                           <td class='docblock-short'>
                                <p>Represents mapped memory and allows frames of data to be 'flooded' (read)
from a device-visible <code>Buffer</code> into its associated host-accessible mapped
memory region in a repeated fashion.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.BufferStreamInner.html"
                                  title='struct ocl::async::BufferStreamInner'>BufferStreamInner</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.FutureFlood.html"
                                  title='struct ocl::async::FutureFlood'>FutureFlood</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.FutureFlush.html"
                                  title='struct ocl::async::FutureFlush'>FutureFlush</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.FutureGuard.html"
                                  title='struct ocl::async::FutureGuard'>FutureGuard</a></td>
                           <td class='docblock-short'>
                                <p>A future that resolves to a read or write guard after ensuring that the
data being guarded is appropriately locked during the execution of an
OpenCL command.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.FutureMemMap.html"
                                  title='struct ocl::async::FutureMemMap'>FutureMemMap</a></td>
                           <td class='docblock-short'>
                                <p>A future which resolves to a <code>MemMap</code> as soon as its creating command
completes.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.MemMap.html"
                                  title='struct ocl::async::MemMap'>MemMap</a></td>
                           <td class='docblock-short'>
                                <p>A view of memory mapped by <code>clEnqueueMap{...}</code>.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.OrderLock.html"
                                  title='struct ocl::async::OrderLock'>OrderLock</a></td>
                           <td class='docblock-short'>
                                <p>A lock with conserved global order which interoperates with OpenCL events
and Rust futures to provide exclusive access to data.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.ReadGuard.html"
                                  title='struct ocl::async::ReadGuard'>ReadGuard</a></td>
                           <td class='docblock-short'>
                                <p>Allows access to the data contained within a lock just like a mutex guard.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.RwVec.html"
                                  title='struct ocl::async::RwVec'>RwVec</a></td>
                           <td class='docblock-short'>
                                <p>A locking <code>Vec</code> which interoperates with OpenCL events and Rust futures to
provide exclusive access to data.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.WriteGuard.html"
                                  title='struct ocl::async::WriteGuard'>WriteGuard</a></td>
                           <td class='docblock-short'>
                                <p>Allows access to the data contained within just like a mutex guard.</p>

                           </td>
                       </tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="trait" href="trait.OrderGuard.html"
                                  title='trait ocl::async::OrderGuard'>OrderGuard</a></td>
                           <td class='docblock-short'>
                                <p>A read or write guard for an <code>OrderLock</code>.</p>

                           </td>
                       </tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="type" href="type.FutureReadGuard.html"
                                  title='type ocl::async::FutureReadGuard'>FutureReadGuard</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="type" href="type.FutureWriteGuard.html"
                                  title='type ocl::async::FutureWriteGuard'>FutureWriteGuard</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </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>
            </div>
        </div>
    </aside>

    

    <script>
        window.rootPath = "../../";
        window.currentCrate = "ocl";
    </script>
    <script src="../../main.js"></script>
    <script defer src="../../search-index.js"></script>
</body>
</html>