clfft 0.3.2

Bindings for clFFT, a FFT library for OpenCL.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

<!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 `loop_fn` fn in crate `futures`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, loop_fn">

    <title>futures::future::loop_fn - Rust</title>

    <link rel="stylesheet" type="text/css" href="../../normalize.css">
    <link rel="stylesheet" type="text/css" href="../../rustdoc.css">
    <link rel="stylesheet" type="text/css" href="../../main.css">
    

    
    
</head>
<body class="rustdoc fn">
    <!--[if lte IE 8]>
    <div class="warning">
        This old browser is unsupported and will most likely display funky
        things.
    </div>
    <![endif]-->

    

    <nav class="sidebar">
        
        <p class='location'><a href='../index.html'>futures</a>::<wbr><a href='index.html'>future</a></p><script>window.sidebarCurrent = {name: 'loop_fn', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script>
    </nav>

    <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'>Function <a href='../index.html'>futures</a>::<wbr><a href='index.html'>future</a>::<wbr><a class="fn" href=''>loop_fn</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/futures/future/loop_fn.rs.html#74-82' title='goto source code'>[src]</a></span></h1>
<pre class='rust fn'>pub fn loop_fn&lt;S, T, A, F&gt;(initial_state: S, func: F) -&gt; <a class="struct" href="../../futures/future/struct.LoopFn.html" title="struct futures::future::LoopFn">LoopFn</a>&lt;A, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.FnMut.html" title="trait core::ops::FnMut">FnMut</a>(S) -&gt; A,<br>&nbsp;&nbsp;&nbsp;&nbsp;A: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>&lt;Item = <a class="enum" href="../../futures/future/enum.Loop.html" title="enum futures::future::Loop">Loop</a>&lt;T, S&gt;&gt;,&nbsp;</span></pre><div class='docblock'><p>Creates a new future implementing a tail-recursive loop.</p>
<p>The loop function is immediately called with <code>initial_state</code> and should
return a value that can be converted to a future. On successful completion,
this future should output a <code>Loop&lt;T, S&gt;</code> to indicate the status of the
loop.</p>
<p><code>Loop::Break(T)</code> halts the loop and completes the future with output <code>T</code>.</p>
<p><code>Loop::Continue(S)</code> reinvokes the loop function with state <code>S</code>. The returned
future will be subsequently polled for a new <code>Loop&lt;T, S&gt;</code> value.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::{<span class="ident">ok</span>, <span class="ident">loop_fn</span>, <span class="ident">Future</span>, <span class="ident">FutureResult</span>, <span class="ident">Loop</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Error</span>;

<span class="kw">struct</span> <span class="ident">Client</span> {
    <span class="ident">ping_count</span>: <span class="ident">u8</span>,
}

<span class="kw">impl</span> <span class="ident">Client</span> {
    <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-&gt;</span> <span class="self">Self</span> {
        <span class="ident">Client</span> { <span class="ident">ping_count</span>: <span class="number">0</span> }
    }

    <span class="kw">fn</span> <span class="ident">send_ping</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">FutureResult</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">Error</span><span class="op">&gt;</span> {
        <span class="ident">ok</span>(<span class="ident">Client</span> { <span class="ident">ping_count</span>: <span class="self">self</span>.<span class="ident">ping_count</span> <span class="op">+</span> <span class="number">1</span> })
    }

    <span class="kw">fn</span> <span class="ident">receive_pong</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">FutureResult</span><span class="op">&lt;</span>(<span class="self">Self</span>, <span class="ident">bool</span>), <span class="ident">Error</span><span class="op">&gt;</span> {
        <span class="kw">let</span> <span class="ident">done</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">ping_count</span> <span class="op">&gt;=</span> <span class="number">5</span>;
        <span class="ident">ok</span>((<span class="self">self</span>, <span class="ident">done</span>))
    }
}

<span class="kw">let</span> <span class="ident">ping_til_done</span> <span class="op">=</span> <span class="ident">loop_fn</span>(<span class="ident">Client</span>::<span class="ident">new</span>(), <span class="op">|</span><span class="ident">client</span><span class="op">|</span> {
    <span class="ident">client</span>.<span class="ident">send_ping</span>()
        .<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">client</span><span class="op">|</span> <span class="ident">client</span>.<span class="ident">receive_pong</span>())
        .<span class="ident">and_then</span>(<span class="op">|</span>(<span class="ident">client</span>, <span class="ident">done</span>)<span class="op">|</span> {
            <span class="kw">if</span> <span class="ident">done</span> {
                <span class="prelude-val">Ok</span>(<span class="ident">Loop</span>::<span class="ident">Break</span>(<span class="ident">client</span>))
            } <span class="kw">else</span> {
                <span class="prelude-val">Ok</span>(<span class="ident">Loop</span>::<span class="ident">Continue</span>(<span class="ident">client</span>))
            }
        })
});</pre>
</div></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>?</dt>
                    <dd>Show this help dialog</dd>
                    <dt>S</dt>
                    <dd>Focus the search field</dd>
                    <dt>&larrb;</dt>
                    <dd>Move up in search results</dd>
                    <dt>&rarrb;</dt>
                    <dd>Move down in search results</dd>
                    <dt>&#9166;</dt>
                    <dd>Go to active search result</dd>
                    <dt>+</dt>
                    <dd>Collapse/expand 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 = "futures";
    </script>
    <script src="../../jquery.js"></script>
    <script src="../../main.js"></script>
    <script defer src="../../search-index.js"></script>
</body>
</html>