fn.unpretty_print.html 6.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <!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 `unpretty_print` fn in crate `synstructure`."><meta name="keywords" content="rust, rustlang, rust-lang, unpretty_print"><title>synstructure::unpretty_print - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></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"><div class="sidebar-menu">&#9776;</div><div class="sidebar-elems"><p class='location'><a href='index.html'>synstructure</a></p><script>window.sidebarCurrent = {name: 'unpretty_print', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Function <a href='index.html'>synstructure</a>::<wbr><a class="fn" href=''>unpretty_print</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/synstructure/lib.rs.html#2215-2236' title='goto source code'>[src]</a></span></h1><pre class='rust fn'>pub fn unpretty_print&lt;T:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>&gt;(ts: T) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></pre><div class='docblock'><p>Dumps an unpretty version of a tokenstream. Takes any type which implements
  2. <code>Display</code>.</p>
  3. <p>This is mostly useful for visualizing the output of a procedural macro, as
  4. it makes it marginally more readable. It is used in the implementation of
  5. <code>test_derive!</code> to unprettily print the output.</p>
  6. <h1 id="stability" class="section-header"><a href="#stability">Stability</a></h1>
  7. <p>The stability of the output of this function is not guaranteed. Do not
  8. assert that the output of this function does not change between minor
  9. versions.</p>
  10. <h1 id="example" class="section-header"><a href="#example">Example</a></h1>
  11. <pre class="rust rust-example-rendered">
  12. <span class="macro">assert_eq</span><span class="macro">!</span>(
  13. <span class="ident">synstructure</span>::<span class="ident">unpretty_print</span>(<span class="macro">quote</span><span class="macro">!</span> {
  14. <span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
  15. <span class="kw">const</span> <span class="ident">_DERIVE_krate_Trait_FOR_A</span>: () <span class="op">=</span> {
  16. <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">krate</span>;
  17. <span class="kw">impl</span><span class="op">&lt;</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">&gt;</span> <span class="ident">krate</span>::<span class="ident">Trait</span> <span class="kw">for</span> <span class="ident">A</span><span class="op">&lt;</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">&gt;</span>
  18. <span class="kw">where</span>
  19. <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">U</span><span class="op">&gt;</span>: <span class="ident">krate</span>::<span class="ident">Trait</span>,
  20. <span class="ident">U</span>: <span class="ident">krate</span>::<span class="ident">Trait</span>
  21. {
  22. <span class="kw">fn</span> <span class="ident">a</span>() {}
  23. }
  24. };
  25. }),
  26. <span class="string">&quot;# [
  27. allow (
  28. non_upper_case_globals )
  29. ]
  30. const _DERIVE_krate_Trait_FOR_A : (
  31. )
  32. = {
  33. extern crate krate ;
  34. impl &lt; T , U &gt; krate :: Trait for A &lt; T , U &gt; where Option &lt; U &gt; : krate :: Trait , U : krate :: Trait {
  35. fn a (
  36. )
  37. {
  38. }
  39. }
  40. }
  41. ;
  42. &quot;</span>
  43. )</pre>
  44. </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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "synstructure";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>