aboutsummaryrefslogtreecommitdiff
path: root/docs/posts/auto-currying_rust_functions
diff options
context:
space:
mode:
Diffstat (limited to 'docs/posts/auto-currying_rust_functions')
-rw-r--r--docs/posts/auto-currying_rust_functions/index.html550
1 files changed, 550 insertions, 0 deletions
diff --git a/docs/posts/auto-currying_rust_functions/index.html b/docs/posts/auto-currying_rust_functions/index.html
new file mode 100644
index 0000000..a8b7055
--- /dev/null
+++ b/docs/posts/auto-currying_rust_functions/index.html
@@ -0,0 +1,550 @@
1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <link rel="stylesheet" href="/style.css">
5 <link rel="stylesheet" href="/syntax.css">
6 <meta charset="UTF-8">
7 <meta name="viewport" content="initial-scale=1">
8 <meta content="#ffffff" name="theme-color">
9 <meta name="HandheldFriendly" content="true">
10 <meta property="og:title" content="Auto-currying Rust Functions">
11 <meta property="og:type" content="website">
12 <meta property="og:description" content="a static site {for, by, about} me ">
13 <meta property="og:url" content="https://peppe.rs">
14 <link rel="icon" type="image/x-icon" href="/favicon.png">
15 <title>Auto-currying Rust Functions · peppe.rs</title>
16 <body>
17 <div class="posts">
18 <div class="post">
19 <a href="/" class="post-end-link">⟵ Back</a>
20 <a class="stats post-end-link" href="https://raw.githubusercontent.com/nerdypepper/site/master/posts/auto-currying_rust_functions.md
21">View Raw</a>
22 <div class="separator"></div>
23 <div class="date">
24 09/05 — 2020
25 <div class="stats">
26 <span class="stats-number">
27 356.43
28 </span>
29 <span class="stats-unit">cm</span>
30 &nbsp
31 <span class="stats-number">
32 25.1
33 </span>
34 <span class="stats-unit">min</span>
35 </div>
36 </div>
37 <h1>
38 Auto-currying Rust Functions
39 </h1>
40 <div class="post-text">
41 <p>This post contains a gentle introduction to procedural macros in Rust and a guide to writing a procedural macro to curry Rust functions. The source code for the entire library can be found <a href="https://github.com/nerdypepper/cutlass">here</a>. It is also available on <a href="https://crates.io/crates/cutlass">crates.io</a>.</p>
42<p>The following links might prove to be useful before getting started:</p>
43<ul>
44<li><a href="https://doc.rust-lang.org/reference/procedural-macros.html">Procedural Macros</a></li>
45<li><a href="https://en.wikipedia.org/wiki/Currying">Currying</a></li>
46</ul>
47<p>Or you can pretend you read them, because I have included a primer here :)</p>
48<h3 id="contents">Contents</h3>
49<ol type="1">
50<li><a href="#currying">Currying</a><br />
51</li>
52<li><a href="#procedural-macros">Procedural Macros</a><br />
53</li>
54<li><a href="#definitions">Definitions</a><br />
55</li>
56<li><a href="#refinement">Refinement</a><br />
57</li>
58<li><a href="#the-in-betweens">The In-betweens</a><br />
59     5.1 <a href="#dependencies">Dependencies</a><br />
60     5.2 <a href="#the-attribute-macro">The attribute macro</a><br />
61     5.3 <a href="#function-body">Function Body</a><br />
62     5.4 <a href="#function-signature">Function Signature</a><br />
63     5.5 <a href="#getting-it-together">Getting it together</a><br />
64</li>
65<li><a href="#debugging-and-testing">Debugging and Testing</a><br />
66</li>
67<li><a href="#notes">Notes</a><br />
68</li>
69<li><a href="#conclusion">Conclusion</a></li>
70</ol>
71<h3 id="currying">Currying</h3>
72<p>Currying is the process of transformation of a function call like <code>f(a, b, c)</code> to <code>f(a)(b)(c)</code>. A curried function returns a concrete value only when it receives all its arguments! If it does recieve an insufficient amount of arguments, say 1 of 3, it returns a <em>curried function</em>, that returns after receiving 2 arguments.</p>
73<pre><code>curry(f(a, b, c)) = h(a)(b)(c)
74
75h(x) = g &lt;- curried function that takes upto 2 args (g)
76g(y) = k &lt;- curried function that takes upto 1 arg (k)
77k(z) = v &lt;- a value (v)
78
79Keen readers will conclude the following,
80h(x)(y)(z) = g(y)(z) = k(z) = v</code></pre>
81<p>Mathematically, if <code>f</code> is a function that takes two arguments <code>x</code> and <code>y</code>, such that <code>x ϵ X</code>, and <code>y ϵ Y</code> , we write it as:</p>
82<pre><code>f: (X × Y) -&gt; Z</code></pre>
83<p>where <code>×</code> denotes the Cartesian product of set <code>X</code> and <code>Y</code>, and curried <code>f</code> (denoted by <code>h</code> here) is written as:</p>
84<pre><code>h: X -&gt; (Y -&gt; Z)</code></pre>
85<h3 id="procedural-macros">Procedural Macros</h3>
86<p>These are functions that take code as input and spit out modified code as output. Powerful stuff. Rust has three kinds of proc-macros:</p>
87<ul>
88<li>Function like macros: <code>println!</code>, <code>vec!</code>.</li>
89<li>Derive macros: <code>#[derive(...)]</code>, used to automatically implement traits for structs/enums.</li>
90<li>and Attribute macros: <code>#[test]</code>, usually slapped onto functions.</li>
91</ul>
92<p>We will be using Attribute macros to convert a Rust function into a curried Rust function, which we should be able to call via: <code>function(arg1)(arg2)</code>.</p>
93<h3 id="definitions">Definitions</h3>
94<p>Being respectable programmers, we define the input to and the output from our proc-macro. Here’s a good non-trivial function to start out with:</p>
95<div class="sourceCode" id="cb4"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb4-1"><a href="#cb4-1"></a><span class="kw">fn</span> add(x<span class="op">:</span> <span class="dt">u32</span><span class="op">,</span> y<span class="op">:</span> <span class="dt">u32</span><span class="op">,</span> z<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span></span>
96<span id="cb4-2"><a href="#cb4-2"></a> <span class="kw">return</span> x <span class="op">+</span> y <span class="op">+</span> z<span class="op">;</span></span>
97<span id="cb4-3"><a href="#cb4-3"></a><span class="op">}</span></span></code></pre></div>
98<p>Hmm, what would our output look like? What should our proc-macro generate ideally? Well, if we understood currying correctly, we should accept an argument and return a function that accepts an argument and returns … you get the point. Something like this should do:</p>
99<div class="sourceCode" id="cb5"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb5-1"><a href="#cb5-1"></a><span class="kw">fn</span> add_curried1(x<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="op">?</span> <span class="op">{</span></span>
100<span id="cb5-2"><a href="#cb5-2"></a> <span class="kw">return</span> <span class="kw">fn</span> add_curried2 (y<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="op">?</span> <span class="op">{</span></span>
101<span id="cb5-3"><a href="#cb5-3"></a> <span class="kw">return</span> <span class="kw">fn</span> add_curried3 (z<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span></span>
102<span id="cb5-4"><a href="#cb5-4"></a> <span class="kw">return</span> x <span class="op">+</span> y <span class="op">+</span> z<span class="op">;</span></span>
103<span id="cb5-5"><a href="#cb5-5"></a> <span class="op">}</span></span>
104<span id="cb5-6"><a href="#cb5-6"></a> <span class="op">}</span></span>
105<span id="cb5-7"><a href="#cb5-7"></a><span class="op">}</span></span></code></pre></div>
106<p>A couple of things to note:</p>
107<p><strong>Return types</strong><br />
108We have placed <code>?</code>s in place of return types. Let’s try to fix that. <code>add_curried3</code> returns the ‘value’, so <code>u32</code> is accurate. <code>add_curried2</code> returns <code>add_curried3</code>. What is the type of <code>add_curried3</code>? It is a function that takes in a <code>u32</code> and returns a <code>u32</code>. So a <code>fn(u32) -&gt; u32</code> will do right? No, I’ll explain why in the next point, but for now, we will make use of the <code>Fn</code> trait, our return type is <code>impl Fn(u32) -&gt; u32</code>. This basically tells the compiler that we will be returning something function-like, a.k.a, behaves like a <code>Fn</code>. Cool!</p>
109<p>If you have been following along, you should be able to tell that the return type of <code>add_curried1</code> is:</p>
110<pre><code>impl Fn(u32) -&gt; (impl Fn(u32) -&gt; u32)</code></pre>
111<p>We can drop the parentheses because <code>-&gt;</code> is right associative:</p>
112<pre><code>impl Fn(u32) -&gt; impl Fn(u32) -&gt; u32
113</code></pre>
114<p><strong>Accessing environment</strong><br />
115A function cannot access it’s environment. Our solution will not work. <code>add_curried3</code> attempts to access <code>x</code>, which is not allowed! A closure<a href="#fn1" class="footnote-ref" id="fnref1" role="doc-noteref"><sup>1</sup></a> however, can. If we are returning a closure, our return type must be <code>impl Fn</code>, and not <code>fn</code>. The difference between the <code>Fn</code> trait and function pointers is beyond the scope of this post.</p>
116<h3 id="refinement">Refinement</h3>
117<p>Armed with knowledge, we refine our expected output, this time, employing closures:</p>
118<pre><code>fn add(x: u32) -&gt; impl Fn(u32) -&gt; impl Fn(u32) -&gt; u32 {
119 return move |y| move |z| x + y + z;
120}</code></pre>
121<p>Alas, that does not compile either! It errors out with the following message:</p>
122<pre><code>error[E0562]: `impl Trait` not allowed outside of function
123and inherent method return types
124 --&gt; src/main.rs:17:37
125 |
126 | fn add(x: u32) -&gt; impl Fn(u32) -&gt; impl Fn(u32) -&gt; u32
127 | ^^^^^^^^^^^^^^^^^^^
128</code></pre>
129<p>You are allowed to return an <code>impl Fn</code> only inside a function. We are currently returning it from another return! Or at least, that was the most I could make out of the error message.</p>
130<p>We are going to have to cheat a bit to fix this issue; with type aliases and a convenient nightly feature <a href="#fn2" class="footnote-ref" id="fnref2" role="doc-noteref"><sup>2</sup></a>:</p>
131<div class="sourceCode" id="cb10"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb10-1"><a href="#cb10-1"></a><span class="at">#![</span>feature<span class="at">(</span>type_alias_impl_trait<span class="at">)]</span> <span class="co">// allows us to use `impl Fn` in type aliases!</span></span>
132<span id="cb10-2"><a href="#cb10-2"></a></span>
133<span id="cb10-3"><a href="#cb10-3"></a><span class="kw">type</span> T0 <span class="op">=</span> <span class="dt">u32</span><span class="op">;</span> <span class="co">// the return value when zero args are to be applied</span></span>
134<span id="cb10-4"><a href="#cb10-4"></a><span class="kw">type</span> T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> T0<span class="op">;</span> <span class="co">// the return value when one arg is to be applied</span></span>
135<span id="cb10-5"><a href="#cb10-5"></a><span class="kw">type</span> T2 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> T1<span class="op">;</span> <span class="co">// the return value when two args are to be applied</span></span>
136<span id="cb10-6"><a href="#cb10-6"></a></span>
137<span id="cb10-7"><a href="#cb10-7"></a><span class="kw">fn</span> add(x<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> T2 <span class="op">{</span></span>
138<span id="cb10-8"><a href="#cb10-8"></a> <span class="kw">return</span> <span class="kw">move</span> <span class="op">|</span>y<span class="op">|</span> <span class="kw">move</span> <span class="op">|</span>z<span class="op">|</span> x <span class="op">+</span> y <span class="op">+</span> z<span class="op">;</span></span>
139<span id="cb10-9"><a href="#cb10-9"></a><span class="op">}</span></span></code></pre></div>
140<p>Drop that into a cargo project, call <code>add(4)(5)(6)</code>, cross your fingers, and run <code>cargo +nightly run</code>. You should see a 15 unless you forgot to print it!</p>
141<h3 id="the-in-betweens">The In-Betweens</h3>
142<p>Let us write the magical bits that take us from function to curried function.</p>
143<p>Initialize your workspace with <code>cargo new --lib currying</code>. Proc-macro crates are libraries with exactly one export, the macro itself. Add a <code>tests</code> directory to your crate root. Your directory should look something like this:</p>
144<pre><code>.
145├── Cargo.toml
146├── src
147│   └── lib.rs
148└── tests
149 └── smoke.rs</code></pre>
150<h4 id="dependencies">Dependencies</h4>
151<p>We will be using a total of 3 external crates:</p>
152<ul>
153<li><a href="https://docs.rs/proc-macro2/1.0.12/proc_macro2/">proc_macro2</a></li>
154<li><a href="https://docs.rs/syn/1.0.18/syn/index.html">syn</a></li>
155<li><a href="https://docs.rs/quote/1.0.4/quote/index.html">quote</a></li>
156</ul>
157<p>Here’s a sample <code>Cargo.toml</code>:</p>
158<pre><code># Cargo.toml
159
160[dependencies]
161proc-macro2 = &quot;1.0.9&quot;
162quote = &quot;1.0&quot;
163
164[dependencies.syn]
165version = &quot;1.0&quot;
166features = [&quot;full&quot;]
167
168[lib]
169proc-macro = true # this is important!</code></pre>
170<p>We will be using an external <code>proc-macro2</code> crate as well as an internal <code>proc-macro</code> crate. Not confusing at all!</p>
171<h4 id="the-attribute-macro">The attribute macro</h4>
172<p>Drop this into <code>src/lib.rs</code>, to get the ball rolling.</p>
173<div class="sourceCode" id="cb13"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb13-1"><a href="#cb13-1"></a><span class="co">// src/lib.rs</span></span>
174<span id="cb13-2"><a href="#cb13-2"></a></span>
175<span id="cb13-3"><a href="#cb13-3"></a><span class="kw">use</span> <span class="pp">proc_macro::</span>TokenStream<span class="op">;</span> <span class="co">// 1</span></span>
176<span id="cb13-4"><a href="#cb13-4"></a><span class="kw">use</span> <span class="pp">quote::</span>quote<span class="op">;</span></span>
177<span id="cb13-5"><a href="#cb13-5"></a><span class="kw">use</span> <span class="pp">syn::</span><span class="op">{</span>parse_macro_input<span class="op">,</span> ItemFn<span class="op">};</span></span>
178<span id="cb13-6"><a href="#cb13-6"></a></span>
179<span id="cb13-7"><a href="#cb13-7"></a><span class="at">#[</span>proc_macro_attribute<span class="at">]</span> <span class="co">// 2</span></span>
180<span id="cb13-8"><a href="#cb13-8"></a><span class="kw">pub</span> <span class="kw">fn</span> curry(_attr<span class="op">:</span> TokenStream<span class="op">,</span> item<span class="op">:</span> TokenStream) <span class="op">-&gt;</span> TokenStream <span class="op">{</span></span>
181<span id="cb13-9"><a href="#cb13-9"></a> <span class="kw">let</span> parsed <span class="op">=</span> <span class="pp">parse_macro_input!</span>(item <span class="kw">as</span> ItemFn)<span class="op">;</span> <span class="co">// 3</span></span>
182<span id="cb13-10"><a href="#cb13-10"></a> generate_curry(parsed)<span class="op">.</span>into() <span class="co">// 4</span></span>
183<span id="cb13-11"><a href="#cb13-11"></a><span class="op">}</span></span>
184<span id="cb13-12"><a href="#cb13-12"></a></span>
185<span id="cb13-13"><a href="#cb13-13"></a><span class="kw">fn</span> generate_curry(parsed<span class="op">:</span> ItemFn) <span class="op">-&gt;</span> <span class="pp">proc_macro2::</span>TokenStream <span class="op">{}</span></span></code></pre></div>
186<p><strong>1. Imports</strong></p>
187<p>A <code>Tokenstream</code> holds (hopefully valid) Rust code, this is the type of our input and output. Note that we are importing this type from <code>proc_macro</code> and not <code>proc_macro2</code>.</p>
188<p><code>quote!</code> from the <code>quote</code> crate is a macro that allows us to quickly produce <code>TokenStream</code>s. Much like the LISP <code>quote</code> procedure, you can use the <code>quote!</code> macro for symbolic transformations.</p>
189<p><code>ItemFn</code> from the <code>syn</code> crate holds the parsed <code>TokenStream</code> of a Rust function. <code>parse_macro_input!</code> is a helper macro provided by <code>syn</code>.</p>
190<p><strong>2. The lone export</strong></p>
191<p>Annotate the only <code>pub</code> of our crate with <code>#[proc_macro_attribute]</code>. This tells rustc that <code>curry</code> is a procedural macro, and allows us to use it as <code>#[crate_name::curry]</code> in other crates. Note the signature of the <code>curry</code> function. <code>_attr</code> is the <code>TokenStream</code> representing the attribute itself, <code>item</code> refers to the thing we slapped our macro into, in this case a function (like <code>add</code>). The return value is a modified <code>TokenStream</code>, this will contain our curried version of <code>add</code>.</p>
192<p><strong>3. The helper macro</strong></p>
193<p>A <code>TokenStream</code> is a little hard to work with, which is why we have the <code>syn</code> crate, which provides types to represent Rust tokens. An <code>RArrow</code> struct to represent the return arrow on a function and so on. One of those types is <code>ItemFn</code>, that represents an entire Rust function. The <code>parse_macro_input!</code> automatically puts the input to our macro into an <code>ItemFn</code>. What a gentleman!</p>
194<p><strong>4. Returning <code>TokenStream</code>s </strong></p>
195<p>We haven’t filled in <code>generate_curry</code> yet, but we can see that it returns a <code>proc_macro2::TokenStream</code> and not a <code>proc_macro::TokenStream</code>, so drop a <code>.into()</code> to convert it.</p>
196<p>Lets move on, and fill in <code>generate_curry</code>, I would suggest keeping the documentation for <a href="https://docs.rs/syn/1.0.19/syn/struct.ItemFn.html"><code>syn::ItemFn</code></a> and <a href="https://docs.rs/syn/1.0.19/syn/struct.Signature.html"><code>syn::Signature</code></a> open.</p>
197<div class="sourceCode" id="cb14"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb14-1"><a href="#cb14-1"></a><span class="co">// src/lib.rs</span></span>
198<span id="cb14-2"><a href="#cb14-2"></a></span>
199<span id="cb14-3"><a href="#cb14-3"></a><span class="kw">fn</span> generate_curry(parsed<span class="op">:</span> ItemFn) <span class="op">-&gt;</span> <span class="pp">proc_macro2::</span>TokenStream <span class="op">{</span></span>
200<span id="cb14-4"><a href="#cb14-4"></a> <span class="kw">let</span> fn_body <span class="op">=</span> parsed<span class="op">.</span>block<span class="op">;</span> <span class="co">// function body</span></span>
201<span id="cb14-5"><a href="#cb14-5"></a> <span class="kw">let</span> sig <span class="op">=</span> parsed<span class="op">.</span>sig<span class="op">;</span> <span class="co">// function signature</span></span>
202<span id="cb14-6"><a href="#cb14-6"></a> <span class="kw">let</span> vis <span class="op">=</span> parsed<span class="op">.</span>vis<span class="op">;</span> <span class="co">// visibility, pub or not</span></span>
203<span id="cb14-7"><a href="#cb14-7"></a> <span class="kw">let</span> fn_name <span class="op">=</span> sig<span class="op">.</span>ident<span class="op">;</span> <span class="co">// function name/identifier</span></span>
204<span id="cb14-8"><a href="#cb14-8"></a> <span class="kw">let</span> fn_args <span class="op">=</span> sig<span class="op">.</span>inputs<span class="op">;</span> <span class="co">// comma separated args</span></span>
205<span id="cb14-9"><a href="#cb14-9"></a> <span class="kw">let</span> fn_return_type <span class="op">=</span> sig<span class="op">.</span>output<span class="op">;</span> <span class="co">// return type</span></span>
206<span id="cb14-10"><a href="#cb14-10"></a><span class="op">}</span></span></code></pre></div>
207<p>We are simply extracting the bits of the function, we will be reusing the original function’s visibility and name. Take a look at what <code>syn::Signature</code> can tell us about a function:</p>
208<pre><code> .-- syn::Ident (ident)
209 /
210 fn add(x: u32, y: u32) -&gt; u32
211 (fn_token) / ~~~~~~~,~~~~~~ ~~~~~~
212syn::token::Fn --&#39; / \ (output)
213 &#39; `- syn::ReturnType
214 Punctuated&lt;FnArg, Comma&gt; (inputs)</code></pre>
215<p>Enough analysis, lets produce our first bit of Rust code.</p>
216<h4 id="function-body">Function Body</h4>
217<p>Recall that the body of a curried <code>add</code> should look like this:</p>
218<div class="sourceCode" id="cb16"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb16-1"><a href="#cb16-1"></a><span class="kw">return</span> <span class="kw">move</span> <span class="op">|</span>y<span class="op">|</span> <span class="kw">move</span> <span class="op">|</span>z<span class="op">|</span> x <span class="op">+</span> y <span class="op">+</span> z<span class="op">;</span></span></code></pre></div>
219<p>And in general:</p>
220<div class="sourceCode" id="cb17"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb17-1"><a href="#cb17-1"></a><span class="kw">return</span> <span class="kw">move</span> <span class="op">|</span>arg2<span class="op">|</span> <span class="kw">move</span> <span class="op">|</span>arg3<span class="op">|</span> <span class="op">...</span> <span class="op">|</span>argN<span class="op">|</span> <span class="op">&lt;</span>function body here<span class="op">&gt;</span></span></code></pre></div>
221<p>We already have the function’s body, provided by <code>fn_body</code>, in our <code>generate_curry</code> function. All that’s left to add is the <code>move |arg2| move |arg3| ...</code> stuff, for which we need to extract the argument identifiers (doc: <a href="https://docs.rs/syn/1.0.18/syn/punctuated/struct.Punctuated.html">Punctuated</a>, <a href="https://docs.rs/syn/1.0.18/syn/enum.FnArg.html">FnArg</a>, <a href="https://docs.rs/syn/1.0.18/syn/struct.PatType.html">PatType</a>):</p>
222<div class="sourceCode" id="cb18"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb18-1"><a href="#cb18-1"></a><span class="co">// src/lib.rs</span></span>
223<span id="cb18-2"><a href="#cb18-2"></a><span class="kw">use</span> <span class="pp">syn::punctuated::</span>Punctuated<span class="op">;</span></span>
224<span id="cb18-3"><a href="#cb18-3"></a><span class="kw">use</span> <span class="pp">syn::</span><span class="op">{</span>parse_macro_input<span class="op">,</span> FnArg<span class="op">,</span> Pat<span class="op">,</span> ItemFn<span class="op">,</span> Block<span class="op">};</span></span>
225<span id="cb18-4"><a href="#cb18-4"></a></span>
226<span id="cb18-5"><a href="#cb18-5"></a><span class="kw">fn</span> extract_arg_idents(fn_args<span class="op">:</span> Punctuated<span class="op">&lt;</span>FnArg<span class="op">,</span> <span class="pp">syn::token::</span>Comma<span class="op">&gt;</span>) <span class="op">-&gt;</span> <span class="dt">Vec</span><span class="op">&lt;</span><span class="dt">Box</span><span class="op">&lt;</span>Pat<span class="op">&gt;&gt;</span> <span class="op">{</span> </span>
227<span id="cb18-6"><a href="#cb18-6"></a> <span class="kw">return</span> fn_args<span class="op">.</span>into_iter()<span class="op">.</span>map(extract_arg_pat)<span class="op">.</span><span class="pp">collect::</span><span class="op">&lt;</span><span class="dt">Vec</span><span class="op">&lt;</span>_<span class="op">&gt;&gt;</span>()<span class="op">;</span></span>
228<span id="cb18-7"><a href="#cb18-7"></a><span class="op">}</span></span></code></pre></div>
229<p>Alright, so we are iterating over function args (<code>Punctuated</code> is a collection that you can iterate over) and mapping an <code>extract_arg_pat</code> to every item. What’s <code>extract_arg_pat</code>?</p>
230<div class="sourceCode" id="cb19"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb19-1"><a href="#cb19-1"></a><span class="co">// src/lib.rs</span></span>
231<span id="cb19-2"><a href="#cb19-2"></a></span>
232<span id="cb19-3"><a href="#cb19-3"></a><span class="kw">fn</span> extract_arg_pat(a<span class="op">:</span> FnArg) <span class="op">-&gt;</span> <span class="dt">Box</span><span class="op">&lt;</span>Pat<span class="op">&gt;</span> <span class="op">{</span></span>
233<span id="cb19-4"><a href="#cb19-4"></a> <span class="kw">match</span> a <span class="op">{</span></span>
234<span id="cb19-5"><a href="#cb19-5"></a> <span class="pp">FnArg::</span>Typed(p) <span class="op">=&gt;</span> p<span class="op">.</span>pat<span class="op">,</span></span>
235<span id="cb19-6"><a href="#cb19-6"></a> _ <span class="op">=&gt;</span> <span class="pp">panic!</span>(<span class="st">&quot;Not supported on types with `self`!&quot;</span>)<span class="op">,</span></span>
236<span id="cb19-7"><a href="#cb19-7"></a> <span class="op">}</span></span>
237<span id="cb19-8"><a href="#cb19-8"></a><span class="op">}</span></span></code></pre></div>
238<p><code>FnArg</code> is an enum type as you might have guessed. The <code>Typed</code> variant encompasses args that are written as <code>name: type</code> and the other variant, <code>Reciever</code> refers to <code>self</code> types. Ignore those for now, keep it simple.</p>
239<p>Every <code>FnArg::Typed</code> value contains a <code>pat</code>, which is in essence, the name of the argument. The type of the arg is accessible via <code>p.ty</code> (we will be using this later).</p>
240<p>With that done, we should be able to write the codegen for the function body:</p>
241<div class="sourceCode" id="cb20"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb20-1"><a href="#cb20-1"></a><span class="co">// src/lib.rs</span></span>
242<span id="cb20-2"><a href="#cb20-2"></a></span>
243<span id="cb20-3"><a href="#cb20-3"></a><span class="kw">fn</span> generate_body(fn_args<span class="op">:</span> <span class="op">&amp;</span>[<span class="dt">Box</span><span class="op">&lt;</span>Pat<span class="op">&gt;</span>]<span class="op">,</span> body<span class="op">:</span> <span class="dt">Box</span><span class="op">&lt;</span>Block<span class="op">&gt;</span>) <span class="op">-&gt;</span> <span class="pp">proc_macro2::</span>TokenStream <span class="op">{</span></span>
244<span id="cb20-4"><a href="#cb20-4"></a> <span class="pp">quote!</span> <span class="op">{</span></span>
245<span id="cb20-5"><a href="#cb20-5"></a> <span class="kw">return</span> #( <span class="kw">move</span> <span class="op">|</span>#fn_args<span class="op">|</span> )<span class="op">*</span> #body</span>
246<span id="cb20-6"><a href="#cb20-6"></a> <span class="op">}</span></span>
247<span id="cb20-7"><a href="#cb20-7"></a><span class="op">}</span></span></code></pre></div>
248<p>That is some scary looking syntax! Allow me to explain. The <code>quote!{ ... }</code> returns a <code>proc_macro2::TokenStream</code>, if we wrote <code>quote!{ let x = 1 + 2; }</code>, it wouldn’t create a new variable <code>x</code> with value 3, it would literally produce a stream of tokens with that expression.</p>
249<p>The <code>#</code> enables variable interpolation. <code>#body</code> will look for <code>body</code> in the current scope, take its value, and insert it in the returned <code>TokenStream</code>. Kinda like quasi quoting in LISPs, you have written one.</p>
250<p>What about <code>#( move |#fn_args| )*</code>? That is repetition. <code>quote</code> iterates through <code>fn_args</code>, and drops a <code>move</code> behind each one, it then places pipes (<code>|</code>), around it.</p>
251<p>Let us test our first bit of codegen! Modify <code>generate_curry</code> like so:</p>
252<div class="sourceCode" id="cb21"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb21-1"><a href="#cb21-1"></a><span class="co">// src/lib.rs</span></span>
253<span id="cb21-2"><a href="#cb21-2"></a></span>
254<span id="cb21-3"><a href="#cb21-3"></a> <span class="kw">fn</span> generate_curry(parsed<span class="op">:</span> ItemFn) <span class="op">-&gt;</span> TokenStream <span class="op">{</span></span>
255<span id="cb21-4"><a href="#cb21-4"></a> <span class="kw">let</span> fn_body <span class="op">=</span> parsed<span class="op">.</span>block<span class="op">;</span></span>
256<span id="cb21-5"><a href="#cb21-5"></a> <span class="kw">let</span> sig <span class="op">=</span> parsed<span class="op">.</span>sig<span class="op">;</span></span>
257<span id="cb21-6"><a href="#cb21-6"></a> <span class="kw">let</span> vis <span class="op">=</span> parsed<span class="op">.</span>vis<span class="op">;</span></span>
258<span id="cb21-7"><a href="#cb21-7"></a> <span class="kw">let</span> fn_name <span class="op">=</span> sig<span class="op">.</span>ident<span class="op">;</span></span>
259<span id="cb21-8"><a href="#cb21-8"></a> <span class="kw">let</span> fn_args <span class="op">=</span> sig<span class="op">.</span>inputs<span class="op">;</span></span>
260<span id="cb21-9"><a href="#cb21-9"></a> <span class="kw">let</span> fn_return_type <span class="op">=</span> sig<span class="op">.</span>output<span class="op">;</span></span>
261<span id="cb21-10"><a href="#cb21-10"></a></span>
262<span id="cb21-11"><a href="#cb21-11"></a><span class="op">+</span> <span class="kw">let</span> arg_idents <span class="op">=</span> extract_arg_idents(fn_args<span class="op">.</span>clone())<span class="op">;</span></span>
263<span id="cb21-12"><a href="#cb21-12"></a><span class="op">+</span> <span class="kw">let</span> first_ident <span class="op">=</span> <span class="op">&amp;</span>arg_idents<span class="op">.</span>first()<span class="op">.</span>unwrap()<span class="op">;</span></span>
264<span id="cb21-13"><a href="#cb21-13"></a></span>
265<span id="cb21-14"><a href="#cb21-14"></a><span class="op">+</span> <span class="co">// remember, our curried body starts with the second argument!</span></span>
266<span id="cb21-15"><a href="#cb21-15"></a><span class="op">+</span> <span class="kw">let</span> curried_body <span class="op">=</span> generate_body(<span class="op">&amp;</span>arg_idents[<span class="dv">1</span><span class="op">..</span>]<span class="op">,</span> fn_body<span class="op">.</span>clone())<span class="op">;</span></span>
267<span id="cb21-16"><a href="#cb21-16"></a><span class="op">+</span> <span class="pp">println!</span>(<span class="st">&quot;{}&quot;</span><span class="op">,</span> curried_body)<span class="op">;</span></span>
268<span id="cb21-17"><a href="#cb21-17"></a></span>
269<span id="cb21-18"><a href="#cb21-18"></a> <span class="kw">return</span> <span class="pp">TokenStream::</span>new()<span class="op">;</span></span>
270<span id="cb21-19"><a href="#cb21-19"></a> <span class="op">}</span></span></code></pre></div>
271<p>Add a little test to <code>tests/</code>:</p>
272<div class="sourceCode" id="cb22"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb22-1"><a href="#cb22-1"></a><span class="co">// tests/smoke.rs</span></span>
273<span id="cb22-2"><a href="#cb22-2"></a></span>
274<span id="cb22-3"><a href="#cb22-3"></a><span class="at">#[</span><span class="pp">currying::</span>curry<span class="at">]</span></span>
275<span id="cb22-4"><a href="#cb22-4"></a><span class="kw">fn</span> add(x<span class="op">:</span> <span class="dt">u32</span><span class="op">,</span> y<span class="op">:</span> <span class="dt">u32</span><span class="op">,</span> z<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span></span>
276<span id="cb22-5"><a href="#cb22-5"></a> x <span class="op">+</span> y <span class="op">+</span> z</span>
277<span id="cb22-6"><a href="#cb22-6"></a><span class="op">}</span></span>
278<span id="cb22-7"><a href="#cb22-7"></a></span>
279<span id="cb22-8"><a href="#cb22-8"></a><span class="at">#[</span>test<span class="at">]</span></span>
280<span id="cb22-9"><a href="#cb22-9"></a><span class="kw">fn</span> works() <span class="op">{</span></span>
281<span id="cb22-10"><a href="#cb22-10"></a> <span class="pp">assert!</span>(<span class="cn">true</span>)<span class="op">;</span></span>
282<span id="cb22-11"><a href="#cb22-11"></a><span class="op">}</span></span></code></pre></div>
283<p>You should find something like this in the output of <code>cargo test</code>:</p>
284<pre><code>return move | y | move | z | { x + y + z }</code></pre>
285<p>Glorious <code>println!</code> debugging!</p>
286<h4 id="function-signature">Function signature</h4>
287<p>This section gets into the more complicated bits of the macro, generating type aliases and the function signature. By the end of this section, we should have a full working auto-currying macro!</p>
288<p>Recall what our generated type aliases should look like, for our <code>add</code> function:</p>
289<div class="sourceCode" id="cb24"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb24-1"><a href="#cb24-1"></a><span class="kw">type</span> T0 <span class="op">=</span> <span class="dt">u32</span><span class="op">;</span></span>
290<span id="cb24-2"><a href="#cb24-2"></a><span class="kw">type</span> T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> T0<span class="op">;</span></span>
291<span id="cb24-3"><a href="#cb24-3"></a><span class="kw">type</span> T2 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> T1<span class="op">;</span></span></code></pre></div>
292<p>In general:</p>
293<div class="sourceCode" id="cb25"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb25-1"><a href="#cb25-1"></a><span class="kw">type</span> T0 <span class="op">=</span> <span class="op">&lt;</span><span class="kw">return</span> <span class="kw">type</span>&gt;<span class="op">;</span></span>
294<span id="cb25-2"><a href="#cb25-2"></a><span class="kw">type</span> T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="op">&lt;</span><span class="kw">type</span> of arg N&gt;) -&gt; T0<span class="op">;</span></span>
295<span id="cb25-3"><a href="#cb25-3"></a><span class="kw">type</span> T2 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="op">&lt;</span><span class="kw">type</span> of arg N - 1&gt;) -&gt; T1<span class="op">;</span></span>
296<span id="cb25-4"><a href="#cb25-4"></a><span class="op">.</span></span>
297<span id="cb25-5"><a href="#cb25-5"></a><span class="op">.</span></span>
298<span id="cb25-6"><a href="#cb25-6"></a><span class="op">.</span></span>
299<span id="cb25-7"><a href="#cb25-7"></a><span class="kw">type</span> T(N-1) <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="op">&lt;</span><span class="kw">type</span> of arg 2&gt;) -&gt; T(N-2)<span class="op">;</span></span></code></pre></div>
300<p>To codegen that, we need the types of:</p>
301<ul>
302<li>all our inputs (arguments)</li>
303<li>the output (the return type)</li>
304</ul>
305<p>To fetch the types of all our inputs, we can simply reuse the bits we wrote to fetch the names of all our inputs! (doc: <a href="https://docs.rs/syn/1.0.18/syn/enum.Type.html">Type</a>)</p>
306<div class="sourceCode" id="cb26"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb26-1"><a href="#cb26-1"></a><span class="co">// src/lib.rs</span></span>
307<span id="cb26-2"><a href="#cb26-2"></a></span>
308<span id="cb26-3"><a href="#cb26-3"></a><span class="kw">use</span> <span class="pp">syn::</span><span class="op">{</span>parse_macro_input<span class="op">,</span> Block<span class="op">,</span> FnArg<span class="op">,</span> ItemFn<span class="op">,</span> Pat<span class="op">,</span> ReturnType<span class="op">,</span> Type<span class="op">};</span></span>
309<span id="cb26-4"><a href="#cb26-4"></a></span>
310<span id="cb26-5"><a href="#cb26-5"></a><span class="kw">fn</span> extract_type(a<span class="op">:</span> FnArg) <span class="op">-&gt;</span> <span class="dt">Box</span><span class="op">&lt;</span>Type<span class="op">&gt;</span> <span class="op">{</span></span>
311<span id="cb26-6"><a href="#cb26-6"></a> <span class="kw">match</span> a <span class="op">{</span></span>
312<span id="cb26-7"><a href="#cb26-7"></a> <span class="pp">FnArg::</span>Typed(p) <span class="op">=&gt;</span> p<span class="op">.</span>ty<span class="op">,</span> <span class="co">// notice `ty` instead of `pat`</span></span>
313<span id="cb26-8"><a href="#cb26-8"></a> _ <span class="op">=&gt;</span> <span class="pp">panic!</span>(<span class="st">&quot;Not supported on types with `self`!&quot;</span>)<span class="op">,</span></span>
314<span id="cb26-9"><a href="#cb26-9"></a> <span class="op">}</span></span>
315<span id="cb26-10"><a href="#cb26-10"></a><span class="op">}</span></span>
316<span id="cb26-11"><a href="#cb26-11"></a></span>
317<span id="cb26-12"><a href="#cb26-12"></a><span class="kw">fn</span> extract_arg_types(fn_args<span class="op">:</span> Punctuated<span class="op">&lt;</span>FnArg<span class="op">,</span> <span class="pp">syn::token::</span>Comma<span class="op">&gt;</span>) <span class="op">-&gt;</span> <span class="dt">Vec</span><span class="op">&lt;</span><span class="dt">Box</span><span class="op">&lt;</span>Type<span class="op">&gt;&gt;</span> <span class="op">{</span></span>
318<span id="cb26-13"><a href="#cb26-13"></a> <span class="kw">return</span> fn_args<span class="op">.</span>into_iter()<span class="op">.</span>map(extract_type)<span class="op">.</span><span class="pp">collect::</span><span class="op">&lt;</span><span class="dt">Vec</span><span class="op">&lt;</span>_<span class="op">&gt;&gt;</span>()<span class="op">;</span></span>
319<span id="cb26-14"><a href="#cb26-14"></a></span>
320<span id="cb26-15"><a href="#cb26-15"></a><span class="op">}</span></span></code></pre></div>
321<p>A good reader would have looked at the docs for output member of the <code>syn::Signature</code> struct. It has the type <code>syn::ReturnType</code>. So there is no extraction to do here right? There are actually a couple of things we have to ensure here:</p>
322<ol type="1">
323<li><p>We need to ensure that the function returns! A function that does not return is pointless in this case, and I will tell you why, in the <a href="#notes">Notes</a> section.</p></li>
324<li><p>A <code>ReturnType</code> encloses the arrow of the return as well, we need to get rid of that. Recall:</p>
325<div class="sourceCode" id="cb27"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb27-1"><a href="#cb27-1"></a><span class="kw">type</span> T0 <span class="op">=</span> <span class="dt">u32</span></span>
326<span id="cb27-2"><a href="#cb27-2"></a><span class="co">// and not</span></span>
327<span id="cb27-3"><a href="#cb27-3"></a><span class="kw">type</span> T0 <span class="op">=</span> <span class="op">-&gt;</span> <span class="dt">u32</span></span></code></pre></div></li>
328</ol>
329<p>Here is the snippet that handles extraction of the return type (doc: <a href="https://docs.rs/syn/1.0.19/syn/enum.ReturnType.html">syn::ReturnType</a>):</p>
330<div class="sourceCode" id="cb28"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb28-1"><a href="#cb28-1"></a><span class="co">// src/lib.rs</span></span>
331<span id="cb28-2"><a href="#cb28-2"></a></span>
332<span id="cb28-3"><a href="#cb28-3"></a><span class="kw">fn</span> extract_return_type(a<span class="op">:</span> ReturnType) <span class="op">-&gt;</span> <span class="dt">Box</span><span class="op">&lt;</span>Type<span class="op">&gt;</span> <span class="op">{</span></span>
333<span id="cb28-4"><a href="#cb28-4"></a> <span class="kw">match</span> a <span class="op">{</span></span>
334<span id="cb28-5"><a href="#cb28-5"></a> <span class="pp">ReturnType::</span>Type(_<span class="op">,</span> p) <span class="op">=&gt;</span> p<span class="op">,</span></span>
335<span id="cb28-6"><a href="#cb28-6"></a> _ <span class="op">=&gt;</span> <span class="pp">panic!</span>(<span class="st">&quot;Not supported on functions without return types!&quot;</span>)<span class="op">,</span></span>
336<span id="cb28-7"><a href="#cb28-7"></a> <span class="op">}</span></span>
337<span id="cb28-8"><a href="#cb28-8"></a><span class="op">}</span></span></code></pre></div>
338<p>You might notice that we are making extensive use of the <code>panic!</code> macro. Well, that is because it is a good idea to quit on receiving an unsatisfactory <code>TokenStream</code>.</p>
339<p>With all our types ready, we can get on with generating type aliases:</p>
340<div class="sourceCode" id="cb29"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb29-1"><a href="#cb29-1"></a><span class="co">// src/lib.rs</span></span>
341<span id="cb29-2"><a href="#cb29-2"></a></span>
342<span id="cb29-3"><a href="#cb29-3"></a><span class="kw">use</span> <span class="pp">quote::</span><span class="op">{</span>quote<span class="op">,</span> format_ident<span class="op">};</span></span>
343<span id="cb29-4"><a href="#cb29-4"></a></span>
344<span id="cb29-5"><a href="#cb29-5"></a><span class="kw">fn</span> generate_type_aliases(</span>
345<span id="cb29-6"><a href="#cb29-6"></a> fn_arg_types<span class="op">:</span> <span class="op">&amp;</span>[<span class="dt">Box</span><span class="op">&lt;</span>Type<span class="op">&gt;</span>]<span class="op">,</span></span>
346<span id="cb29-7"><a href="#cb29-7"></a> fn_return_type<span class="op">:</span> <span class="dt">Box</span><span class="op">&lt;</span>Type<span class="op">&gt;,</span></span>
347<span id="cb29-8"><a href="#cb29-8"></a> fn_name<span class="op">:</span> <span class="op">&amp;</span><span class="pp">syn::</span>Ident<span class="op">,</span></span>
348<span id="cb29-9"><a href="#cb29-9"></a>) <span class="op">-&gt;</span> <span class="dt">Vec</span><span class="op">&lt;</span><span class="pp">proc_macro2::</span>TokenStream<span class="op">&gt;</span> <span class="op">{</span> <span class="co">// 1</span></span>
349<span id="cb29-10"><a href="#cb29-10"></a></span>
350<span id="cb29-11"><a href="#cb29-11"></a> <span class="kw">let</span> type_t0 <span class="op">=</span> <span class="pp">format_ident!</span>(<span class="st">&quot;_{}_T0&quot;</span><span class="op">,</span> fn_name)<span class="op">;</span> <span class="co">// 2</span></span>
351<span id="cb29-12"><a href="#cb29-12"></a> <span class="kw">let</span> <span class="kw">mut</span> type_aliases <span class="op">=</span> <span class="pp">vec!</span>[<span class="pp">quote!</span> <span class="op">{</span> <span class="kw">type</span> #type_t0 <span class="op">=</span> #fn_return_type <span class="op">}</span>]<span class="op">;</span></span>
352<span id="cb29-13"><a href="#cb29-13"></a></span>
353<span id="cb29-14"><a href="#cb29-14"></a> <span class="co">// 3</span></span>
354<span id="cb29-15"><a href="#cb29-15"></a> <span class="kw">for</span> (i<span class="op">,</span> t) <span class="kw">in</span> (<span class="dv">1</span><span class="op">..</span>)<span class="op">.</span>zip(fn_arg_types<span class="op">.</span>into_iter()<span class="op">.</span>rev()) <span class="op">{</span></span>
355<span id="cb29-16"><a href="#cb29-16"></a> <span class="kw">let</span> p <span class="op">=</span> <span class="pp">format_ident!</span>(<span class="st">&quot;_{}_{}&quot;</span><span class="op">,</span> fn_name<span class="op">,</span> <span class="pp">format!</span>(<span class="st">&quot;T{}&quot;</span><span class="op">,</span> i <span class="op">-</span> <span class="dv">1</span>))<span class="op">;</span></span>
356<span id="cb29-17"><a href="#cb29-17"></a> <span class="kw">let</span> n <span class="op">=</span> <span class="pp">format_ident!</span>(<span class="st">&quot;_{}_{}&quot;</span><span class="op">,</span> fn_name<span class="op">,</span> <span class="pp">format!</span>(<span class="st">&quot;T{}&quot;</span><span class="op">,</span> i))<span class="op">;</span></span>
357<span id="cb29-18"><a href="#cb29-18"></a></span>
358<span id="cb29-19"><a href="#cb29-19"></a> type_aliases<span class="op">.</span>push(<span class="pp">quote!</span> <span class="op">{</span></span>
359<span id="cb29-20"><a href="#cb29-20"></a> <span class="kw">type</span> #n <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(#t) <span class="op">-&gt;</span> #p</span>
360<span id="cb29-21"><a href="#cb29-21"></a> <span class="op">}</span>)<span class="op">;</span></span>
361<span id="cb29-22"><a href="#cb29-22"></a> <span class="op">}</span></span>
362<span id="cb29-23"><a href="#cb29-23"></a></span>
363<span id="cb29-24"><a href="#cb29-24"></a> <span class="kw">return</span> type_aliases<span class="op">;</span></span>
364<span id="cb29-25"><a href="#cb29-25"></a><span class="op">}</span></span></code></pre></div>
365<p><strong>1. The return value</strong><br />
366We are returning a <code>Vec&lt;proc_macro2::TokenStream&gt;</code>, i. e., a list of <code>TokenStream</code>s, where each item is a type alias.</p>
367<p><strong>2. Format identifier?</strong><br />
368I’ve got some explanation to do on this line. Clearly, we are trying to write the first type alias, and initialize our <code>TokenStream</code> vector with <code>T0</code>, because it is different from the others:</p>
369<div class="sourceCode" id="cb30"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb30-1"><a href="#cb30-1"></a><span class="kw">type</span> T0 <span class="op">=</span> something</span>
370<span id="cb30-2"><a href="#cb30-2"></a><span class="co">// the others are of the form</span></span>
371<span id="cb30-3"><a href="#cb30-3"></a><span class="kw">type</span> Tr <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(something) <span class="op">-&gt;</span> something</span></code></pre></div>
372<p><code>format_ident!</code> is similar to <code>format!</code>. Instead of returning a formatted string, it returns a <code>syn::Ident</code>. Therefore, <code>type_t0</code> is actually an identifier for, in the case of our <code>add</code> function, <code>_add_T0</code>. Why is this formatting important? Namespacing.</p>
373<p>Picture this, we have two functions, <code>add</code> and <code>subtract</code>, that we wish to curry with our macro:</p>
374<div class="sourceCode" id="cb31"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb31-1"><a href="#cb31-1"></a><span class="at">#[</span>curry<span class="at">]</span></span>
375<span id="cb31-2"><a href="#cb31-2"></a><span class="kw">fn</span> add(<span class="op">...</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span> <span class="op">...</span> <span class="op">}</span></span>
376<span id="cb31-3"><a href="#cb31-3"></a></span>
377<span id="cb31-4"><a href="#cb31-4"></a><span class="at">#[</span>curry<span class="at">]</span></span>
378<span id="cb31-5"><a href="#cb31-5"></a><span class="kw">fn</span> sub(<span class="op">...</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span> <span class="op">...</span> <span class="op">}</span></span></code></pre></div>
379<p>Here is the same but with macros expanded:</p>
380<div class="sourceCode" id="cb32"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb32-1"><a href="#cb32-1"></a><span class="kw">type</span> T0 <span class="op">=</span> <span class="dt">u32</span><span class="op">;</span></span>
381<span id="cb32-2"><a href="#cb32-2"></a><span class="kw">type</span> T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> T0<span class="op">;</span></span>
382<span id="cb32-3"><a href="#cb32-3"></a><span class="kw">fn</span> add( <span class="op">...</span> ) <span class="op">-&gt;</span> T1 <span class="op">{</span> <span class="op">...</span> <span class="op">}</span></span>
383<span id="cb32-4"><a href="#cb32-4"></a></span>
384<span id="cb32-5"><a href="#cb32-5"></a><span class="kw">type</span> T0 <span class="op">=</span> <span class="dt">u32</span><span class="op">;</span></span>
385<span id="cb32-6"><a href="#cb32-6"></a><span class="kw">type</span> T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> T0<span class="op">;</span></span>
386<span id="cb32-7"><a href="#cb32-7"></a><span class="kw">fn</span> sub( <span class="op">...</span> ) <span class="op">-&gt;</span> T1 <span class="op">{</span> <span class="op">...</span> <span class="op">}</span></span></code></pre></div>
387<p>We end up with two definitions of <code>T0</code>! Now, if we do the little <code>format_ident!</code> dance we did up there:</p>
388<div class="sourceCode" id="cb33"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb33-1"><a href="#cb33-1"></a><span class="kw">type</span> _add_T0 <span class="op">=</span> <span class="dt">u32</span><span class="op">;</span></span>
389<span id="cb33-2"><a href="#cb33-2"></a><span class="kw">type</span> _add_T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> _add_T0<span class="op">;</span></span>
390<span id="cb33-3"><a href="#cb33-3"></a><span class="kw">fn</span> add( <span class="op">...</span> ) <span class="op">-&gt;</span> _add_T1 <span class="op">{</span> <span class="op">...</span> <span class="op">}</span></span>
391<span id="cb33-4"><a href="#cb33-4"></a></span>
392<span id="cb33-5"><a href="#cb33-5"></a><span class="kw">type</span> _sub_T0 <span class="op">=</span> <span class="dt">u32</span><span class="op">;</span></span>
393<span id="cb33-6"><a href="#cb33-6"></a><span class="kw">type</span> _sub_T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> _sub_T0<span class="op">;</span></span>
394<span id="cb33-7"><a href="#cb33-7"></a><span class="kw">fn</span> sub( <span class="op">...</span> ) <span class="op">-&gt;</span> _sub_T1 <span class="op">{</span> <span class="op">...</span> <span class="op">}</span></span></code></pre></div>
395<p>Voilà! The type aliases don’t tread on each other. Remember to import <code>format_ident</code> from the <code>quote</code> crate.</p>
396<p><strong>3. The TokenStream Vector</strong></p>
397<p>We iterate over our types in reverse order (<code>T0</code> is the last return, <code>T1</code> is the second last, so on), assign a number to each iteration with <code>zip</code>, generate type names with <code>format_ident</code>, push a <code>TokenStream</code> with the help of <code>quote</code> and variable interpolation.</p>
398<p>If you are wondering why we used <code>(1..).zip()</code> instead of <code>.enumerate()</code>, it’s because we wanted to start counting from 1 instead of 0 (we are already done with <code>T0</code>!).</p>
399<h4 id="getting-it-together">Getting it together</h4>
400<p>I promised we’d have a fully working macro by the end of last section. I lied, we have to tie everything together in our <code>generate_curry</code> function:</p>
401<div class="sourceCode" id="cb34"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb34-1"><a href="#cb34-1"></a><span class="co">// src/lib.rs</span></span>
402<span id="cb34-2"><a href="#cb34-2"></a></span>
403<span id="cb34-3"><a href="#cb34-3"></a> <span class="kw">fn</span> generate_curry(parsed<span class="op">:</span> ItemFn) <span class="op">-&gt;</span> <span class="pp">proc_macro2::</span>TokenStream <span class="op">{</span></span>
404<span id="cb34-4"><a href="#cb34-4"></a> <span class="kw">let</span> fn_body <span class="op">=</span> parsed<span class="op">.</span>block<span class="op">;</span></span>
405<span id="cb34-5"><a href="#cb34-5"></a> <span class="kw">let</span> sig <span class="op">=</span> parsed<span class="op">.</span>sig<span class="op">;</span></span>
406<span id="cb34-6"><a href="#cb34-6"></a> <span class="kw">let</span> vis <span class="op">=</span> parsed<span class="op">.</span>vis<span class="op">;</span></span>
407<span id="cb34-7"><a href="#cb34-7"></a> <span class="kw">let</span> fn_name <span class="op">=</span> sig<span class="op">.</span>ident<span class="op">;</span></span>
408<span id="cb34-8"><a href="#cb34-8"></a> <span class="kw">let</span> fn_args <span class="op">=</span> sig<span class="op">.</span>inputs<span class="op">;</span></span>
409<span id="cb34-9"><a href="#cb34-9"></a> <span class="kw">let</span> fn_return_type <span class="op">=</span> sig<span class="op">.</span>output<span class="op">;</span></span>
410<span id="cb34-10"><a href="#cb34-10"></a></span>
411<span id="cb34-11"><a href="#cb34-11"></a> <span class="kw">let</span> arg_idents <span class="op">=</span> extract_arg_idents(fn_args<span class="op">.</span>clone())<span class="op">;</span></span>
412<span id="cb34-12"><a href="#cb34-12"></a> <span class="kw">let</span> first_ident <span class="op">=</span> <span class="op">&amp;</span>arg_idents<span class="op">.</span>first()<span class="op">.</span>unwrap()<span class="op">;</span></span>
413<span id="cb34-13"><a href="#cb34-13"></a> <span class="kw">let</span> curried_body <span class="op">=</span> generate_body(<span class="op">&amp;</span>arg_idents[<span class="dv">1</span><span class="op">..</span>]<span class="op">,</span> fn_body<span class="op">.</span>clone())<span class="op">;</span></span>
414<span id="cb34-14"><a href="#cb34-14"></a></span>
415<span id="cb34-15"><a href="#cb34-15"></a><span class="op">+</span> <span class="kw">let</span> arg_types <span class="op">=</span> extract_arg_types(fn_args<span class="op">.</span>clone())<span class="op">;</span></span>
416<span id="cb34-16"><a href="#cb34-16"></a><span class="op">+</span> <span class="kw">let</span> first_type <span class="op">=</span> <span class="op">&amp;</span>arg_types<span class="op">.</span>first()<span class="op">.</span>unwrap()<span class="op">;</span></span>
417<span id="cb34-17"><a href="#cb34-17"></a><span class="op">+</span> <span class="kw">let</span> type_aliases <span class="op">=</span> generate_type_aliases(</span>
418<span id="cb34-18"><a href="#cb34-18"></a><span class="op">+</span> <span class="op">&amp;</span>arg_types[<span class="dv">1</span><span class="op">..</span>]<span class="op">,</span></span>
419<span id="cb34-19"><a href="#cb34-19"></a><span class="op">+</span> extract_return_type(fn_return_type)<span class="op">,</span></span>
420<span id="cb34-20"><a href="#cb34-20"></a><span class="op">+</span> <span class="op">&amp;</span>fn_name<span class="op">,</span></span>
421<span id="cb34-21"><a href="#cb34-21"></a><span class="op">+</span> )<span class="op">;</span></span>
422<span id="cb34-22"><a href="#cb34-22"></a></span>
423<span id="cb34-23"><a href="#cb34-23"></a><span class="op">+</span> <span class="kw">let</span> return_type <span class="op">=</span> <span class="pp">format_ident!</span>(<span class="st">&quot;_{}_{}&quot;</span><span class="op">,</span> <span class="op">&amp;</span>fn_name<span class="op">,</span> <span class="pp">format!</span>(<span class="st">&quot;T{}&quot;</span><span class="op">,</span> type_aliases<span class="op">.</span>len() <span class="op">-</span> <span class="dv">1</span>))<span class="op">;</span></span>
424<span id="cb34-24"><a href="#cb34-24"></a></span>
425<span id="cb34-25"><a href="#cb34-25"></a><span class="op">+</span> <span class="kw">return</span> <span class="pp">quote!</span> <span class="op">{</span></span>
426<span id="cb34-26"><a href="#cb34-26"></a><span class="op">+</span> #(#type_aliases)<span class="op">;*</span> <span class="op">;</span></span>
427<span id="cb34-27"><a href="#cb34-27"></a><span class="op">+</span> #vis <span class="kw">fn</span> #fn_name (#first_ident<span class="op">:</span> #first_type) <span class="op">-&gt;</span> #return_type <span class="op">{</span></span>
428<span id="cb34-28"><a href="#cb34-28"></a><span class="op">+</span> #curried_body <span class="op">;</span></span>
429<span id="cb34-29"><a href="#cb34-29"></a><span class="op">+</span> <span class="op">}</span></span>
430<span id="cb34-30"><a href="#cb34-30"></a><span class="op">+</span> <span class="op">};</span></span>
431<span id="cb34-31"><a href="#cb34-31"></a> <span class="op">}</span></span></code></pre></div>
432<p>Most of the additions are self explanatory, I’ll go through the return statement with you. We are returning a <code>quote!{ ... }</code>, so a <code>proc_macro2::TokenStream</code>. We are iterating through the <code>type_aliases</code> variable, which you might recall, is a <code>Vec&lt;TokenStream&gt;</code>. You might notice the sneaky semicolon before the <code>*</code>. This basically tells <code>quote</code>, to insert an item, then a semicolon, and then the next one, another semicolon, and so on. The semicolon is a separator. We need to manually insert another semicolon at the end of it all, <code>quote</code> doesn’t insert a separator at the end of the iteration.</p>
433<p>We retain the visibility and name of our original function. Our curried function takes as args, just the first argument of our original function. The return type of our curried function is actually, the last type alias we create. If you think back to our manually curried <code>add</code> function, we returned <code>T2</code>, which was in fact, the last type alias we created.</p>
434<p>I am sure, at this point, you are itching to test this out, but before that, let me introduce you to some good methods of debugging proc-macro code.</p>
435<h3 id="debugging-and-testing">Debugging and Testing</h3>
436<p>Install <code>cargo-expand</code> via:</p>
437<pre><code>cargo install cargo-expand</code></pre>
438<p><code>cargo-expand</code> is a neat little tool that expands your macro in places where it is used, and lets you view the generated code! For example:</p>
439<pre class="shell"><code># create a bin package hello
440$ cargo new hello
441
442# view the expansion of the println! macro
443$ cargo expand
444
445#![feature(prelude_import)]
446#[prelude_import]
447use std::prelude::v1::*;
448#[macro_use]
449extern crate std;
450fn main() {
451 {
452 ::std::io::_print(::core::fmt::Arguments::new_v1(
453 &amp;[&quot;Hello, world!\n&quot;],
454 &amp;match () {
455 () =&gt; [],
456 },
457 ));
458 };
459}</code></pre>
460<p>Writing proc-macros without <code>cargo-expand</code> is tantamount to driving a vehicle without rear view mirrors! Keep an eye on what is going on behind your back.</p>
461<p>Now, your macro won’t always compile, you might just recieve the bee movie script as an error. <code>cargo-expand</code> will not work in such cases. I would suggest printing out your variables to inspect them. <code>TokenStream</code> implements <code>Display</code> as well as <code>Debug</code>. We don’t always have to be respectable programmers. Just print it.</p>
462<p>Enough of that, lets get testing:</p>
463<div class="sourceCode" id="cb37"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb37-1"><a href="#cb37-1"></a><span class="co">// tests/smoke.rs</span></span>
464<span id="cb37-2"><a href="#cb37-2"></a></span>
465<span id="cb37-3"><a href="#cb37-3"></a><span class="at">#![</span>feature<span class="at">(</span>type_alias_impl_trait<span class="at">)]</span></span>
466<span id="cb37-4"><a href="#cb37-4"></a></span>
467<span id="cb37-5"><a href="#cb37-5"></a><span class="at">#[</span><span class="pp">crate_name::</span>curry<span class="at">]</span></span>
468<span id="cb37-6"><a href="#cb37-6"></a><span class="kw">fn</span> add(x<span class="op">:</span> <span class="dt">u32</span><span class="op">,</span> y<span class="op">:</span> <span class="dt">u32</span><span class="op">,</span> z<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span></span>
469<span id="cb37-7"><a href="#cb37-7"></a> x <span class="op">+</span> y <span class="op">+</span> z</span>
470<span id="cb37-8"><a href="#cb37-8"></a><span class="op">}</span></span>
471<span id="cb37-9"><a href="#cb37-9"></a></span>
472<span id="cb37-10"><a href="#cb37-10"></a><span class="at">#[</span>test<span class="at">]</span></span>
473<span id="cb37-11"><a href="#cb37-11"></a><span class="kw">fn</span> works() <span class="op">{</span></span>
474<span id="cb37-12"><a href="#cb37-12"></a> <span class="pp">assert_eq!</span>(<span class="dv">15</span><span class="op">,</span> add(<span class="dv">4</span>)(<span class="dv">5</span>)(<span class="dv">6</span>))<span class="op">;</span></span>
475<span id="cb37-13"><a href="#cb37-13"></a><span class="op">}</span></span></code></pre></div>
476<p>Run <code>cargo +nightly test</code>. You should see a pleasing message:</p>
477<pre><code>running 1 test
478test tests::works ... ok</code></pre>
479<p>Take a look at the expansion for our curry macro, via <code>cargo +nightly expand --tests smoke</code>:</p>
480<div class="sourceCode" id="cb39"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb39-1"><a href="#cb39-1"></a><span class="kw">type</span> _add_T0 <span class="op">=</span> <span class="dt">u32</span><span class="op">;</span></span>
481<span id="cb39-2"><a href="#cb39-2"></a><span class="kw">type</span> _add_T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> _add_T0<span class="op">;</span></span>
482<span id="cb39-3"><a href="#cb39-3"></a><span class="kw">type</span> _add_T2 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> _add_T1<span class="op">;</span></span>
483<span id="cb39-4"><a href="#cb39-4"></a><span class="kw">fn</span> add(x<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> _add_T2 <span class="op">{</span></span>
484<span id="cb39-5"><a href="#cb39-5"></a> <span class="kw">return</span> (<span class="kw">move</span> <span class="op">|</span>y<span class="op">|</span> <span class="op">{</span></span>
485<span id="cb39-6"><a href="#cb39-6"></a> <span class="kw">move</span> <span class="op">|</span>z<span class="op">|</span> <span class="op">{</span></span>
486<span id="cb39-7"><a href="#cb39-7"></a> <span class="kw">return</span> x <span class="op">+</span> y <span class="op">+</span> z<span class="op">;</span></span>
487<span id="cb39-8"><a href="#cb39-8"></a> <span class="op">}</span></span>
488<span id="cb39-9"><a href="#cb39-9"></a> <span class="op">}</span>)<span class="op">;</span></span>
489<span id="cb39-10"><a href="#cb39-10"></a><span class="op">}</span></span>
490<span id="cb39-11"><a href="#cb39-11"></a></span>
491<span id="cb39-12"><a href="#cb39-12"></a><span class="co">// a bunch of other stuff generated by #[test] and assert_eq!</span></span></code></pre></div>
492<p>A sight for sore eyes.</p>
493<p>Here is a more complex example that generates ten multiples of the first ten natural numbers:</p>
494<div class="sourceCode" id="cb40"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb40-1"><a href="#cb40-1"></a><span class="at">#[</span>curry<span class="at">]</span></span>
495<span id="cb40-2"><a href="#cb40-2"></a><span class="kw">fn</span> product(x<span class="op">:</span> <span class="dt">u32</span><span class="op">,</span> y<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span></span>
496<span id="cb40-3"><a href="#cb40-3"></a> x <span class="op">*</span> y</span>
497<span id="cb40-4"><a href="#cb40-4"></a><span class="op">}</span></span>
498<span id="cb40-5"><a href="#cb40-5"></a></span>
499<span id="cb40-6"><a href="#cb40-6"></a><span class="kw">fn</span> multiples() <span class="op">-&gt;</span> <span class="dt">Vec</span><span class="op">&lt;</span><span class="dt">Vec</span><span class="op">&lt;</span><span class="dt">u32</span><span class="op">&gt;&gt;{</span></span>
500<span id="cb40-7"><a href="#cb40-7"></a> <span class="kw">let</span> v <span class="op">=</span> (<span class="dv">1</span><span class="op">..=</span><span class="dv">10</span>)<span class="op">.</span>map(product)<span class="op">;</span></span>
501<span id="cb40-8"><a href="#cb40-8"></a> <span class="kw">return</span> (<span class="dv">1</span><span class="op">..=</span><span class="dv">10</span>)</span>
502<span id="cb40-9"><a href="#cb40-9"></a> <span class="op">.</span>map(<span class="op">|</span>x<span class="op">|</span> v<span class="op">.</span>clone()<span class="op">.</span>map(<span class="op">|</span>f<span class="op">|</span> f(x))<span class="op">.</span>collect())</span>
503<span id="cb40-10"><a href="#cb40-10"></a> <span class="op">.</span>collect()<span class="op">;</span></span>
504<span id="cb40-11"><a href="#cb40-11"></a><span class="op">}</span></span></code></pre></div>
505<h3 id="notes">Notes</h3>
506<p>I didn’t quite explain why we use <code>move |arg|</code> in our closure. This is because we want to take ownership of the variable supplied to us. Take a look at this example:</p>
507<div class="sourceCode" id="cb41"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb41-1"><a href="#cb41-1"></a><span class="kw">let</span> v <span class="op">=</span> add(<span class="dv">5</span>)<span class="op">;</span></span>
508<span id="cb41-2"><a href="#cb41-2"></a><span class="kw">let</span> g<span class="op">;</span></span>
509<span id="cb41-3"><a href="#cb41-3"></a><span class="op">{</span></span>
510<span id="cb41-4"><a href="#cb41-4"></a> <span class="kw">let</span> x <span class="op">=</span> <span class="dv">5</span><span class="op">;</span></span>
511<span id="cb41-5"><a href="#cb41-5"></a> g <span class="op">=</span> v(x)<span class="op">;</span></span>
512<span id="cb41-6"><a href="#cb41-6"></a><span class="op">}</span></span>
513<span id="cb41-7"><a href="#cb41-7"></a><span class="pp">println!</span>(<span class="st">&quot;{}&quot;</span><span class="op">,</span> g(<span class="dv">2</span>))<span class="op">;</span></span></code></pre></div>
514<p>Variable <code>x</code> goes out of scope before <code>g</code> can return a concrete value. If we take ownership of <code>x</code> by <code>move</code>ing it into our closure, we can expect this to work reliably. In fact, rustc understands this, and forces you to use <code>move</code>.</p>
515<p>This usage of <code>move</code> is exactly why <strong>a curried function without a return is useless</strong>. Every variable we pass to our curried function gets moved into its local scope. Playing with these variables cannot cause a change outside this scope. Returning is our only method of interaction with anything beyond this function.</p>
516<h3 id="conclusion">Conclusion</h3>
517<p>Currying may not seem to be all that useful. Curried functions are unwieldy in Rust because the standard library is not built around currying. If you enjoy the possibilities posed by currying, consider taking a look at Haskell or Scheme.</p>
518<p>My original intention with <a href="https://peppe.rs">peppe.rs</a> was to post condensed articles, a micro blog, but this one turned out extra long.</p>
519<p>Perhaps I should call it a ‘macro’ blog :)</p>
520<section class="footnotes" role="doc-endnotes">
521<hr />
522<ol>
523<li id="fn1" role="doc-endnote"><p><a href="https://doc.rust-lang.org/book/ch13-01-closures.html">https://doc.rust-lang.org/book/ch13-01-closures.html</a><a href="#fnref1" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
524<li id="fn2" role="doc-endnote"><p><a href="https://caniuse.rs">caniuse.rs</a> contains an indexed list of features and their status.<a href="#fnref2" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
525</ol>
526</section>
527
528 </div>
529
530 <div class=intro>
531 Hi.
532 <div class=hot-links>
533 <a href=https://peppe.rs/index.xml class=feed-button>Subscribe</a>
534 <a href=https://liberapay.com/nerdypepper/donate class=donate-button>Donate</a>
535 </div>
536 <p>I'm Akshay, I go by nerd or nerdypepper on the internet.</p>
537 <p>
538 I am a compsci undergrad, Rust programmer and an enthusiastic Vimmer.
539 I write open-source stuff to pass time. I also design fonts: scientifica, curie.
540 </p>
541 <p>Send me a mail at [email protected] or a message at [email protected].</p>
542 </div>
543
544 <a href="/" class="post-end-link">⟵ Back</a>
545 <a class="stats post-end-link" href="https://raw.githubusercontent.com/nerdypepper/site/master/posts/auto-currying_rust_functions.md
546">View Raw</a>
547 </div>
548 </div>
549 </body>
550</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-25 19:19:52 +0000