2020-04-28 09:01:51 +00:00
|
|
|
|
|
|
|
<style>
|
|
|
|
body { margin: 0; }
|
|
|
|
pre { color: #DCDCCC; background: #3F3F3F; font-size: 22px; padding: 0.4em; }
|
|
|
|
|
|
|
|
.lifetime { color: #DFAF8F; font-style: italic; }
|
|
|
|
.comment { color: #7F9F7F; }
|
2020-06-22 14:28:07 +00:00
|
|
|
.documentation { color: #629755; }
|
2020-06-18 14:30:40 +00:00
|
|
|
.injected { opacity: 0.65 ; }
|
2020-04-28 09:01:51 +00:00
|
|
|
.struct, .enum { color: #7CB8BB; }
|
|
|
|
.enum_variant { color: #BDE0F3; }
|
|
|
|
.string_literal { color: #CC9393; }
|
|
|
|
.field { color: #94BFF3; }
|
|
|
|
.function { color: #93E0E3; }
|
2020-06-08 13:23:03 +00:00
|
|
|
.function.unsafe { color: #BC8383; }
|
|
|
|
.operator.unsafe { color: #BC8383; }
|
2020-04-28 09:01:51 +00:00
|
|
|
.parameter { color: #94BFF3; }
|
|
|
|
.text { color: #DCDCCC; }
|
|
|
|
.type { color: #7CB8BB; }
|
|
|
|
.builtin_type { color: #8CD0D3; }
|
|
|
|
.type_param { color: #DFAF8F; }
|
|
|
|
.attribute { color: #94BFF3; }
|
|
|
|
.numeric_literal { color: #BFEBBF; }
|
|
|
|
.bool_literal { color: #BFE6EB; }
|
|
|
|
.macro { color: #94BFF3; }
|
|
|
|
.module { color: #AFD8AF; }
|
2020-07-11 12:50:00 +00:00
|
|
|
.value_param { color: #DCDCCC; }
|
2020-04-28 09:01:51 +00:00
|
|
|
.variable { color: #DCDCCC; }
|
|
|
|
.format_specifier { color: #CC696B; }
|
|
|
|
.mutable { text-decoration: underline; }
|
2020-06-17 13:27:13 +00:00
|
|
|
.escape_sequence { color: #94BFF3; }
|
2020-04-28 09:01:51 +00:00
|
|
|
.keyword { color: #F0DFAF; font-weight: bold; }
|
|
|
|
.keyword.unsafe { color: #BC8383; font-weight: bold; }
|
|
|
|
.control { font-style: italic; }
|
2020-07-11 12:50:00 +00:00
|
|
|
|
|
|
|
.unresolved_reference { color: #FC5555; text-decoration: wavy underline; }
|
2020-04-28 09:01:51 +00:00
|
|
|
</style>
|
2020-06-23 02:28:09 +00:00
|
|
|
<pre><code><span class="comment documentation">/// ```</span>
|
2020-07-20 15:36:23 +00:00
|
|
|
<span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="generic injected"> </span><span class="punctuation injected">_</span><span class="generic injected"> </span><span class="operator injected">=</span><span class="generic injected"> </span><span class="string_literal injected">"early doctests should not go boom"</span><span class="punctuation injected">;</span><span class="punctuation injected">
|
2020-07-13 20:59:42 +00:00
|
|
|
</span><span class="comment documentation">/// ```</span>
|
2020-07-15 14:34:11 +00:00
|
|
|
<span class="keyword">struct</span> <span class="struct declaration">Foo</span> <span class="punctuation">{</span>
|
|
|
|
<span class="field declaration">bar</span><span class="punctuation">:</span> <span class="builtin_type">bool</span><span class="punctuation">,</span>
|
|
|
|
<span class="punctuation">}</span>
|
2020-06-14 12:43:43 +00:00
|
|
|
|
2020-07-15 14:34:11 +00:00
|
|
|
<span class="keyword">impl</span> <span class="struct">Foo</span> <span class="punctuation">{</span>
|
2020-07-20 15:36:23 +00:00
|
|
|
<span class="keyword">pub</span> <span class="keyword">const</span> <span class="constant declaration">bar</span><span class="punctuation">:</span> <span class="builtin_type">bool</span> <span class="operator">=</span> <span class="bool_literal">true</span><span class="punctuation">;</span>
|
2020-06-14 12:43:43 +00:00
|
|
|
|
2020-06-16 00:17:26 +00:00
|
|
|
<span class="comment documentation">/// Constructs a new `Foo`.</span>
|
|
|
|
<span class="comment documentation">///</span>
|
|
|
|
<span class="comment documentation">/// # Examples</span>
|
|
|
|
<span class="comment documentation">///</span>
|
|
|
|
<span class="comment documentation">/// ```</span>
|
2020-07-21 02:37:31 +00:00
|
|
|
<span class="comment documentation">/// #</span><span class="generic injected"> </span><span class="attribute injected">#</span><span class="attribute injected">!</span><span class="attribute injected">[</span><span class="function attribute injected">allow</span><span class="punctuation injected">(</span><span class="attribute injected">unused_mut</span><span class="punctuation injected">)</span><span class="attribute injected">]</span>
|
2020-07-20 15:36:23 +00:00
|
|
|
<span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="generic injected"> </span><span class="keyword injected">mut</span><span class="generic injected"> </span><span class="variable declaration injected mutable">foo</span><span class="punctuation injected">:</span><span class="generic injected"> </span><span class="struct injected">Foo</span><span class="generic injected"> </span><span class="operator injected">=</span><span class="generic injected"> </span><span class="struct injected">Foo</span><span class="operator injected">::</span><span class="function injected">new</span><span class="punctuation injected">(</span><span class="punctuation injected">)</span><span class="punctuation injected">;</span><span class="punctuation injected">
|
2020-07-13 20:59:42 +00:00
|
|
|
</span> <span class="comment documentation">/// ```</span>
|
2020-07-20 14:21:40 +00:00
|
|
|
<span class="keyword">pub</span> <span class="keyword">const</span> <span class="keyword">fn</span> <span class="function declaration">new</span><span class="punctuation">(</span><span class="punctuation">)</span> <span class="operator">-></span> <span class="struct">Foo</span> <span class="punctuation">{</span>
|
2020-07-15 14:34:11 +00:00
|
|
|
<span class="struct">Foo</span> <span class="punctuation">{</span> <span class="field">bar</span><span class="punctuation">:</span> <span class="bool_literal">true</span> <span class="punctuation">}</span>
|
|
|
|
<span class="punctuation">}</span>
|
2020-04-28 09:01:51 +00:00
|
|
|
|
2020-06-16 00:17:26 +00:00
|
|
|
<span class="comment documentation">/// `bar` method on `Foo`.</span>
|
|
|
|
<span class="comment documentation">///</span>
|
|
|
|
<span class="comment documentation">/// # Examples</span>
|
|
|
|
<span class="comment documentation">///</span>
|
|
|
|
<span class="comment documentation">/// ```</span>
|
2020-07-20 14:21:40 +00:00
|
|
|
<span class="comment documentation">/// </span><span class="keyword injected">use</span><span class="generic injected"> </span><span class="module injected">x</span><span class="operator injected">::</span><span class="module injected">y</span><span class="punctuation injected">;</span>
|
2020-06-22 14:28:07 +00:00
|
|
|
<span class="comment documentation">///</span>
|
2020-07-20 15:36:23 +00:00
|
|
|
<span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="generic injected"> </span><span class="variable declaration injected">foo</span><span class="generic injected"> </span><span class="operator injected">=</span><span class="generic injected"> </span><span class="struct injected">Foo</span><span class="operator injected">::</span><span class="function injected">new</span><span class="punctuation injected">(</span><span class="punctuation injected">)</span><span class="punctuation injected">;</span>
|
2020-06-22 14:28:07 +00:00
|
|
|
<span class="comment documentation">///</span>
|
|
|
|
<span class="comment documentation">/// </span><span class="comment injected">// calls bar on foo</span>
|
2020-07-15 14:34:11 +00:00
|
|
|
<span class="comment documentation">/// </span><span class="macro injected">assert!</span><span class="punctuation injected">(</span><span class="generic injected">foo</span><span class="punctuation injected">.</span><span class="generic injected">bar</span><span class="punctuation injected">(</span><span class="punctuation injected">)</span><span class="punctuation injected">)</span><span class="punctuation injected">;</span>
|
2020-06-22 14:28:07 +00:00
|
|
|
<span class="comment documentation">///</span>
|
2020-07-20 15:36:23 +00:00
|
|
|
<span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="generic injected"> </span><span class="variable declaration injected">bar</span><span class="generic injected"> </span><span class="operator injected">=</span><span class="generic injected"> </span><span class="variable injected">foo</span><span class="punctuation injected">.</span><span class="field injected">bar</span><span class="generic injected"> </span><span class="operator injected">||</span><span class="generic injected"> </span><span class="struct injected">Foo</span><span class="operator injected">::</span><span class="constant injected">bar</span><span class="punctuation injected">;</span>
|
2020-06-22 14:28:07 +00:00
|
|
|
<span class="comment documentation">///</span>
|
|
|
|
<span class="comment documentation">/// </span><span class="comment injected">/* multi-line
|
|
|
|
</span><span class="comment documentation">/// </span><span class="comment injected"> comment */</span>
|
|
|
|
<span class="comment documentation">///</span>
|
2020-07-20 15:36:23 +00:00
|
|
|
<span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="generic injected"> </span><span class="variable declaration injected">multi_line_string</span><span class="generic injected"> </span><span class="operator injected">=</span><span class="generic injected"> </span><span class="string_literal injected">"Foo
|
2020-06-18 13:37:22 +00:00
|
|
|
</span><span class="comment documentation">/// </span><span class="string_literal injected"> bar
|
2020-07-15 14:34:11 +00:00
|
|
|
</span><span class="comment documentation">/// </span><span class="string_literal injected"> "</span><span class="punctuation injected">;</span>
|
2020-06-22 14:28:07 +00:00
|
|
|
<span class="comment documentation">///</span>
|
|
|
|
<span class="comment documentation">/// ```</span>
|
2020-06-16 00:17:26 +00:00
|
|
|
<span class="comment documentation">///</span>
|
|
|
|
<span class="comment documentation">/// ```rust,no_run</span>
|
2020-07-20 15:36:23 +00:00
|
|
|
<span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="generic injected"> </span><span class="variable declaration injected">foobar</span><span class="generic injected"> </span><span class="operator injected">=</span><span class="generic injected"> </span><span class="struct injected">Foo</span><span class="operator injected">::</span><span class="function injected">new</span><span class="punctuation injected">(</span><span class="punctuation injected">)</span><span class="punctuation injected">.</span><span class="function injected">bar</span><span class="punctuation injected">(</span><span class="punctuation injected">)</span><span class="punctuation injected">;</span><span class="punctuation injected">
|
2020-07-13 20:59:42 +00:00
|
|
|
</span> <span class="comment documentation">/// ```</span>
|
2020-06-16 00:17:26 +00:00
|
|
|
<span class="comment documentation">///</span>
|
|
|
|
<span class="comment documentation">/// ```sh</span>
|
|
|
|
<span class="comment documentation">/// echo 1</span>
|
|
|
|
<span class="comment documentation">/// ```</span>
|
2020-07-20 14:21:40 +00:00
|
|
|
<span class="keyword">pub</span> <span class="keyword">fn</span> <span class="function declaration">foo</span><span class="punctuation">(</span><span class="operator">&</span><span class="self_keyword">self</span><span class="punctuation">)</span> <span class="operator">-></span> <span class="builtin_type">bool</span> <span class="punctuation">{</span>
|
2020-04-28 09:01:51 +00:00
|
|
|
<span class="bool_literal">true</span>
|
2020-07-15 14:34:11 +00:00
|
|
|
<span class="punctuation">}</span>
|
|
|
|
<span class="punctuation">}</span>
|
2020-06-19 22:02:42 +00:00
|
|
|
|
|
|
|
<span class="comment documentation">/// ```</span>
|
2020-07-15 14:34:11 +00:00
|
|
|
<span class="comment documentation">/// </span><span class="macro injected">noop!</span><span class="punctuation injected">(</span><span class="numeric_literal injected">1</span><span class="punctuation injected">)</span><span class="punctuation injected">;</span><span class="punctuation injected">
|
2020-07-13 20:59:42 +00:00
|
|
|
</span><span class="comment documentation">/// ```</span>
|
2020-07-15 14:34:11 +00:00
|
|
|
<span class="macro">macro_rules!</span> <span class="macro declaration">noop</span> <span class="punctuation">{</span>
|
2020-07-20 15:36:23 +00:00
|
|
|
<span class="punctuation">(</span><span class="punctuation">$</span>expr<span class="punctuation">:</span>expr<span class="punctuation">)</span> <span class="operator">=</span><span class="punctuation">></span> <span class="punctuation">{</span>
|
2020-07-15 14:34:11 +00:00
|
|
|
<span class="punctuation">$</span>expr
|
|
|
|
<span class="punctuation">}</span>
|
|
|
|
<span class="punctuation">}</span></code></pre>
|