| |
| <style> |
| body { margin: 0; } |
| pre { color: #DCDCCC; background: #3F3F3F; font-size: 22px; padding: 0.4em; } |
| |
| .lifetime { color: #DFAF8F; font-style: italic; } |
| .comment { color: #7F9F7F; } |
| .documentation { color: #629755; } |
| .injected { opacity: 0.65 ; } |
| .struct, .enum { color: #7CB8BB; } |
| .enum_variant { color: #BDE0F3; } |
| .string_literal { color: #CC9393; } |
| .field { color: #94BFF3; } |
| .function { color: #93E0E3; } |
| .function.unsafe { color: #BC8383; } |
| .operator.unsafe { color: #BC8383; } |
| .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; } |
| .variable { color: #DCDCCC; } |
| .format_specifier { color: #CC696B; } |
| .mutable { text-decoration: underline; } |
| .unresolved_reference { color: #FC5555; } |
| .escape_sequence { color: #94BFF3; } |
| |
| .keyword { color: #F0DFAF; font-weight: bold; } |
| .keyword.unsafe { color: #BC8383; font-weight: bold; } |
| .control { font-style: italic; } |
| </style> |
| <pre><code><span class="comment documentation">/// ```</span> |
| <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="generic injected"> _ = </span><span class="string_literal injected">"early doctests should not go boom"</span><span class="generic injected">;</span> |
| <span class="comment documentation">/// ```</span> |
| <span class="keyword">struct</span> <span class="struct declaration">Foo</span> { |
| <span class="field declaration">bar</span>: <span class="builtin_type">bool</span>, |
| } |
| |
| <span class="keyword">impl</span> <span class="struct">Foo</span> { |
| <span class="keyword">pub</span> <span class="keyword">const</span> <span class="constant declaration">bar</span>: <span class="builtin_type">bool</span> = <span class="bool_literal">true</span>; |
| |
| <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> |
| <span class="comment documentation">/// #</span><span class="generic injected"> </span><span class="attribute injected">#![</span><span class="function attribute injected">allow</span><span class="attribute injected">(unused_mut)]</span> |
| <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="generic injected">: </span><span class="struct injected">Foo</span><span class="generic injected"> = </span><span class="struct injected">Foo</span><span class="generic injected">::</span><span class="function injected">new</span><span class="generic injected">();</span> |
| <span class="comment documentation">/// ```</span> |
| <span class="keyword">pub</span> <span class="keyword">const</span> <span class="keyword">fn</span> <span class="function declaration">new</span>() -> <span class="struct">Foo</span> { |
| <span class="struct">Foo</span> { <span class="field">bar</span>: <span class="bool_literal">true</span> } |
| } |
| |
| <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> |
| <span class="comment documentation">/// </span><span class="keyword injected">use</span><span class="generic injected"> </span><span class="module injected">x</span><span class="generic injected">::</span><span class="module injected">y</span><span class="generic injected">;</span> |
| <span class="comment documentation">///</span> |
| <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="struct injected">Foo</span><span class="generic injected">::</span><span class="function injected">new</span><span class="generic injected">();</span> |
| <span class="comment documentation">///</span> |
| <span class="comment documentation">/// </span><span class="comment injected">// calls bar on foo</span> |
| <span class="comment documentation">/// </span><span class="macro injected">assert!</span><span class="generic injected">(foo.bar());</span> |
| <span class="comment documentation">///</span> |
| <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="variable injected">foo</span><span class="generic injected">.</span><span class="field injected">bar</span><span class="generic injected"> || </span><span class="struct injected">Foo</span><span class="generic injected">::</span><span class="constant injected">bar</span><span class="generic injected">;</span> |
| <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> |
| <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="string_literal injected">"Foo |
| </span><span class="comment documentation">/// </span><span class="string_literal injected"> bar |
| </span><span class="comment documentation">/// </span><span class="string_literal injected"> "</span><span class="generic injected">;</span> |
| <span class="comment documentation">///</span> |
| <span class="comment documentation">/// ```</span> |
| <span class="comment documentation">///</span> |
| <span class="comment documentation">/// ```rust,no_run</span> |
| <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="struct injected">Foo</span><span class="generic injected">::</span><span class="function injected">new</span><span class="generic injected">().</span><span class="function injected">bar</span><span class="generic injected">();</span> |
| <span class="comment documentation">/// ```</span> |
| <span class="comment documentation">///</span> |
| <span class="comment documentation">/// ```sh</span> |
| <span class="comment documentation">/// echo 1</span> |
| <span class="comment documentation">/// ```</span> |
| <span class="keyword">pub</span> <span class="keyword">fn</span> <span class="function declaration">foo</span>(&<span class="self_keyword">self</span>) -> <span class="builtin_type">bool</span> { |
| <span class="bool_literal">true</span> |
| } |
| } |
| |
| <span class="comment documentation">/// ```</span> |
| <span class="comment documentation">/// </span><span class="macro injected">noop!</span><span class="generic injected">(</span><span class="numeric_literal injected">1</span><span class="generic injected">);</span> |
| <span class="comment documentation">/// ```</span> |
| <span class="macro">macro_rules!</span> <span class="macro declaration">noop</span> { |
| ($expr:expr) => { |
| $expr |
| } |
| }</code></pre> |