mitchellhansen/Trac3r-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add doc

Browse Source
This commit is contained in:
mitchellhansen
2020-01-23 23:13:36 -08:00
parent dcc0df955e
commit 2bc9ebdc6b
31829 changed files with 1229378 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/downcast_rs/all.html Normal file
View File

@@ -0,0 +1,3 @@
<!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="List of all items in this crate"><meta name="keywords" content="rust, rustlang, rust-lang"><title>List of all items in this crate</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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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><a href='../downcast_rs/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a></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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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>
</span>
<span class='in-band'>List of all items</span></h1><h3 id='Traits'>Traits</h3><ul class='traits docblock'><li><a href='trait.Downcast.html'>Downcast</a></li></ul><h3 id='Macros'>Macros</h3><ul class='macros docblock'><li><a href='macro.impl_downcast.html'>impl_downcast</a></li></ul></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 = "downcast_rs";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>

111
doc/downcast_rs/index.html Normal file
View File

@@ -0,0 +1,111 @@
<!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 `downcast_rs` crate."><meta name="keywords" content="rust, rustlang, rust-lang, downcast_rs"><title>downcast_rs - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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><a href='../downcast_rs/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate downcast_rs</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all downcast_rs's items</p></a><div class="block items"><ul><li><a href="#macros">Macros</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'downcast_rs', ty: 'mod', relpath: '../'};</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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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/downcast_rs/lib.rs.html#1-402' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>downcast_rs</a></span></h1><div class='docblock'><p>Rust enums are great for types where all variations are known beforehand. But in
the case where you want to implement a container of user-defined types, an
open-ended type like a <strong>trait object</strong> is needed. In some cases, it is useful to
cast the trait object back into its original concrete type to access additional
functionality and performant inlined implementations.</p>
<p><code>downcast-rs</code> adds downcasting support to trait objects using only safe Rust. It
supports <strong>type parameters</strong>, <strong>associated types</strong>, and <strong>constraints</strong>.</p>
<p>To make a trait downcastable, make it extend the <code>downcast::Downcast</code> trait and
invoke <code>impl_downcast!</code> on it as follows:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">trait</span> <span class="ident">Trait</span>: <span class="ident">Downcast</span> {}
<span class="macro">impl_downcast</span><span class="macro">!</span>(<span class="ident">Trait</span>);
<span class="comment">// With type parameters.</span>
<span class="kw">trait</span> <span class="ident">TraitGeneric1</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>: <span class="ident">Downcast</span> {}
<span class="macro">impl_downcast</span><span class="macro">!</span>(<span class="ident">TraitGeneric1</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>);
<span class="comment">// With associated types.</span>
<span class="kw">trait</span> <span class="ident">TraitGeneric2</span>: <span class="ident">Downcast</span> { <span class="kw">type</span> <span class="ident">G</span>; <span class="kw">type</span> <span class="ident">H</span>; }
<span class="macro">impl_downcast</span><span class="macro">!</span>(<span class="ident">TraitGeneric2</span> <span class="ident">assoc</span> <span class="ident">G</span>, <span class="ident">H</span>);
<span class="comment">// With constraints on types.</span>
<span class="kw">trait</span> <span class="ident">TraitGeneric3</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">Copy</span><span class="op">&gt;</span>: <span class="ident">Downcast</span> {
<span class="kw">type</span> <span class="ident">H</span>: <span class="ident">Clone</span>;
}
<span class="macro">impl_downcast</span><span class="macro">!</span>(<span class="ident">TraitGeneric3</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> <span class="ident">assoc</span> <span class="ident">H</span> <span class="kw">where</span> <span class="ident">T</span>: <span class="ident">Copy</span>, <span class="ident">H</span>: <span class="ident">Clone</span>);
<span class="comment">// With concrete types.</span>
<span class="kw">trait</span> <span class="ident">TraitConcrete1</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">Copy</span><span class="op">&gt;</span>: <span class="ident">Downcast</span> {}
<span class="macro">impl_downcast</span><span class="macro">!</span>(<span class="ident">concrete</span> <span class="ident">TraitConcrete1</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span>);
<span class="kw">trait</span> <span class="ident">TraitConcrete2</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">Copy</span><span class="op">&gt;</span>: <span class="ident">Downcast</span> { <span class="kw">type</span> <span class="ident">H</span>; }
<span class="macro">impl_downcast</span><span class="macro">!</span>(<span class="ident">concrete</span> <span class="ident">TraitConcrete2</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> <span class="ident">assoc</span> <span class="ident">H</span><span class="op">=</span><span class="ident">f64</span>);</pre></div>
<h1 id="example-without-generics" class="section-header"><a href="#example-without-generics">Example without generics</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="comment">// Import macro via `macro_use` pre-1.30.</span>
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">downcast_rs</span>;
<span class="kw">use</span> <span class="ident">downcast_rs</span>::<span class="ident">Downcast</span>;
<span class="comment">// To create a trait with downcasting methods, extend `Downcast` and run</span>
<span class="comment">// `impl_downcast!()` on the trait.</span>
<span class="kw">trait</span> <span class="ident">Base</span>: <span class="ident">Downcast</span> {}
<span class="macro">impl_downcast</span><span class="macro">!</span>(<span class="ident">Base</span>);
<span class="comment">// Concrete types implementing Base.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">struct</span> <span class="ident">Foo</span>(<span class="ident">u32</span>);
<span class="kw">impl</span> <span class="ident">Base</span> <span class="kw">for</span> <span class="ident">Foo</span> {}
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">struct</span> <span class="ident">Bar</span>(<span class="ident">f64</span>);
<span class="kw">impl</span> <span class="ident">Base</span> <span class="kw">for</span> <span class="ident">Bar</span> {}
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="comment">// Create a trait object.</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">base</span>: <span class="ident">Box</span><span class="op">&lt;</span><span class="ident">Base</span><span class="op">&gt;</span> <span class="op">=</span> <span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">Foo</span>(<span class="number">42</span>));
<span class="comment">// Try sequential downcasts.</span>
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">foo</span>) <span class="op">=</span> <span class="ident">base</span>.<span class="ident">downcast_ref</span>::<span class="op">&lt;</span><span class="ident">Foo</span><span class="op">&gt;</span>() {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="number">0</span>, <span class="number">42</span>);
} <span class="kw">else</span> <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">bar</span>) <span class="op">=</span> <span class="ident">base</span>.<span class="ident">downcast_ref</span>::<span class="op">&lt;</span><span class="ident">Bar</span><span class="op">&gt;</span>() {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">bar</span>.<span class="number">0</span>, <span class="number">42.0</span>);
}
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">base</span>.<span class="ident">is</span>::<span class="op">&lt;</span><span class="ident">Foo</span><span class="op">&gt;</span>());
<span class="comment">// Fail to convert `Box&lt;Base&gt;` into `Box&lt;Bar&gt;`.</span>
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">base</span>.<span class="ident">downcast</span>::<span class="op">&lt;</span><span class="ident">Bar</span><span class="op">&gt;</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">res</span>.<span class="ident">is_err</span>());
<span class="kw">let</span> <span class="ident">base</span> <span class="op">=</span> <span class="ident">res</span>.<span class="ident">unwrap_err</span>();
<span class="comment">// Convert `Box&lt;Base&gt;` into `Box&lt;Foo&gt;`.</span>
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">42</span>, <span class="ident">base</span>.<span class="ident">downcast</span>::<span class="op">&lt;</span><span class="ident">Foo</span><span class="op">&gt;</span>().<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="string">&quot;Shouldn&#39;t happen.&quot;</span>).<span class="ident">unwrap</span>().<span class="number">0</span>);
}</pre></div>
<h1 id="example-with-a-generic-trait-with-associated-types-and-constraints" class="section-header"><a href="#example-with-a-generic-trait-with-associated-types-and-constraints">Example with a generic trait with associated types and constraints</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="comment">// Can call macro via namespace since rust 1.30.</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">downcast_rs</span>;
<span class="kw">use</span> <span class="ident">downcast_rs</span>::<span class="ident">Downcast</span>;
<span class="comment">// To create a trait with downcasting methods, extend `Downcast` and run</span>
<span class="comment">// `impl_downcast!()` on the trait.</span>
<span class="kw">trait</span> <span class="ident">Base</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">Clone</span><span class="op">&gt;</span>: <span class="ident">Downcast</span> { <span class="kw">type</span> <span class="ident">H</span>: <span class="ident">Copy</span>; }
<span class="ident">downcast_rs</span>::<span class="macro">impl_downcast</span><span class="macro">!</span>(<span class="ident">Base</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> <span class="ident">assoc</span> <span class="ident">H</span> <span class="kw">where</span> <span class="ident">T</span>: <span class="ident">Clone</span>, <span class="ident">H</span>: <span class="ident">Copy</span>);
<span class="comment">// or: impl_downcast!(concrete Base&lt;u32&gt; assoc H=f32)</span>
<span class="comment">// Concrete types implementing Base.</span>
<span class="kw">struct</span> <span class="ident">Foo</span>(<span class="ident">u32</span>);
<span class="kw">impl</span> <span class="ident">Base</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">Foo</span> { <span class="kw">type</span> <span class="ident">H</span> <span class="op">=</span> <span class="ident">f32</span>; }
<span class="kw">struct</span> <span class="ident">Bar</span>(<span class="ident">f64</span>);
<span class="kw">impl</span> <span class="ident">Base</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">Bar</span> { <span class="kw">type</span> <span class="ident">H</span> <span class="op">=</span> <span class="ident">f32</span>; }
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="comment">// Create a trait object.</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">base</span>: <span class="ident">Box</span><span class="op">&lt;</span><span class="ident">Base</span><span class="op">&lt;</span><span class="ident">u32</span>, <span class="ident">H</span><span class="op">=</span><span class="ident">f32</span><span class="op">&gt;</span><span class="op">&gt;</span> <span class="op">=</span> <span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">Bar</span>(<span class="number">42.0</span>));
<span class="comment">// Try sequential downcasts.</span>
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">foo</span>) <span class="op">=</span> <span class="ident">base</span>.<span class="ident">downcast_ref</span>::<span class="op">&lt;</span><span class="ident">Foo</span><span class="op">&gt;</span>() {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="number">0</span>, <span class="number">42</span>);
} <span class="kw">else</span> <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">bar</span>) <span class="op">=</span> <span class="ident">base</span>.<span class="ident">downcast_ref</span>::<span class="op">&lt;</span><span class="ident">Bar</span><span class="op">&gt;</span>() {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">bar</span>.<span class="number">0</span>, <span class="number">42.0</span>);
}
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">base</span>.<span class="ident">is</span>::<span class="op">&lt;</span><span class="ident">Bar</span><span class="op">&gt;</span>());
}</pre></div>
</div><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
<table><tr class='module-item'><td><a class="macro" href="macro.impl_downcast.html" title='downcast_rs::impl_downcast macro'>impl_downcast</a></td><td class='docblock-short'><p>Adds downcasting support to traits that extend <code>downcast::Downcast</code> by defining forwarding
methods to the corresponding implementations on <code>std::any::Any</code> in the standard library.</p>
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table><tr class='module-item'><td><a class="trait" href="trait.Downcast.html" title='downcast_rs::Downcast trait'>Downcast</a></td><td class='docblock-short'><p>Supports conversion to <code>Any</code>. Traits to be extended by <code>impl_downcast!</code> must extend <code>Downcast</code>.</p>
</td></tr></table></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 = "downcast_rs";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>

10
doc/downcast_rs/macro.impl_downcast!.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=macro.impl_downcast.html">
</head>
<body>
<p>Redirecting to <a href="macro.impl_downcast.html">macro.impl_downcast.html</a>...</p>
<script>location.replace("macro.impl_downcast.html" + location.search + location.hash);</script>
</body>
</html>

29
doc/downcast_rs/macro.impl_downcast.html Normal file
View File

@@ -0,0 +1,29 @@
<!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 `impl_downcast` macro in crate `downcast_rs`."><meta name="keywords" content="rust, rustlang, rust-lang, impl_downcast"><title>downcast_rs::impl_downcast - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc macro"><!--[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><a href='../downcast_rs/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>downcast_rs</a></p><script>window.sidebarCurrent = {name: 'impl_downcast', ty: 'macro', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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/downcast_rs/lib.rs.html#148-271' title='goto source code'>[src]</a></span><span class='in-band'>Macro <a href='index.html'>downcast_rs</a>::<wbr><a class="macro" href=''>impl_downcast</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><div class="example-wrap"><pre class="rust macro">
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">impl_downcast</span> {
(@<span class="ident">impl_full</span>
<span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_</span>:<span class="ident">ident</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">param_types</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>]
<span class="kw">for</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">forall_types</span>:<span class="ident">ident</span>),<span class="kw-2">*</span>]
<span class="kw">where</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">preds</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>]
) <span class="op">=</span><span class="op">&gt;</span> { ... };
(@<span class="ident">impl_body</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_</span>:<span class="ident">ident</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">types</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>]) <span class="op">=</span><span class="op">&gt;</span> { ... };
(@<span class="ident">inject_where</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">before</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>] <span class="ident">types</span> [] <span class="kw">where</span> [] [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">after</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>]) <span class="op">=</span><span class="op">&gt;</span> { ... };
(@<span class="ident">inject_where</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">before</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>] <span class="ident">types</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">types</span>:<span class="ident">ident</span>),<span class="kw-2">*</span>] <span class="kw">where</span> [] [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">after</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>]) <span class="op">=</span><span class="op">&gt;</span> { ... };
(@<span class="ident">inject_where</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">before</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>] <span class="ident">types</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">types</span>:<span class="ident">ident</span>),<span class="kw-2">*</span>] <span class="kw">where</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">preds</span>:<span class="ident">tt</span>)<span class="op">+</span>] [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">after</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>]) <span class="op">=</span><span class="op">&gt;</span> { ... };
(@<span class="ident">as_item</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">item</span>) <span class="op">=</span><span class="op">&gt;</span> { ... };
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_</span>:<span class="ident">ident</span> ) <span class="op">=</span><span class="op">&gt;</span> { ... };
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_</span>:<span class="ident">ident</span> <span class="op">&lt;</span><span class="op">&gt;</span>) <span class="op">=</span><span class="op">&gt;</span> { ... };
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_</span>:<span class="ident">ident</span> <span class="op">&lt;</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">types</span>:<span class="ident">ident</span>),<span class="op">*</span> <span class="op">&gt;</span>) <span class="op">=</span><span class="op">&gt;</span> { ... };
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_</span>:<span class="ident">ident</span> <span class="op">&lt;</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">types</span>:<span class="ident">ident</span>),<span class="op">*</span> <span class="op">&gt;</span> <span class="kw">where</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">preds</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=</span><span class="op">&gt;</span> { ... };
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_</span>:<span class="ident">ident</span> <span class="ident">assoc</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">atypes</span>:<span class="ident">ident</span>),<span class="kw-2">*</span>) <span class="op">=</span><span class="op">&gt;</span> { ... };
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_</span>:<span class="ident">ident</span> <span class="ident">assoc</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">atypes</span>:<span class="ident">ident</span>),<span class="op">*</span> <span class="kw">where</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">preds</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=</span><span class="op">&gt;</span> { ... };
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_</span>:<span class="ident">ident</span> <span class="op">&lt;</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">types</span>:<span class="ident">ident</span>),<span class="op">*</span> <span class="op">&gt;</span> <span class="ident">assoc</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">atypes</span>:<span class="ident">ident</span>),<span class="kw-2">*</span>) <span class="op">=</span><span class="op">&gt;</span> { ... };
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_</span>:<span class="ident">ident</span> <span class="op">&lt;</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">types</span>:<span class="ident">ident</span>),<span class="op">*</span> <span class="op">&gt;</span> <span class="ident">assoc</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">atypes</span>:<span class="ident">ident</span>),<span class="op">*</span> <span class="kw">where</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">preds</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=</span><span class="op">&gt;</span> { ... };
(<span class="ident">concrete</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_</span>:<span class="ident">ident</span> <span class="op">&lt;</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">types</span>:<span class="ident">ident</span>),<span class="op">*</span> <span class="op">&gt;</span>) <span class="op">=</span><span class="op">&gt;</span> { ... };
(<span class="ident">concrete</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_</span>:<span class="ident">ident</span> <span class="ident">assoc</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">atypes</span>:<span class="ident">ident</span> <span class="op">=</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">aty</span>:<span class="ident">ty</span>),<span class="kw-2">*</span>) <span class="op">=</span><span class="op">&gt;</span> { ... };
(<span class="ident">concrete</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_</span>:<span class="ident">ident</span> <span class="op">&lt;</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">types</span>:<span class="ident">ident</span>),<span class="op">*</span> <span class="op">&gt;</span> <span class="ident">assoc</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">atypes</span>:<span class="ident">ident</span> <span class="op">=</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">aty</span>:<span class="ident">ty</span>),<span class="kw-2">*</span>) <span class="op">=</span><span class="op">&gt;</span> { ... };
}</pre></div>
</div><div class='docblock'><p>Adds downcasting support to traits that extend <code>downcast::Downcast</code> by defining forwarding
methods to the corresponding implementations on <code>std::any::Any</code> in the standard library.</p>
<p>See https://users.rust-lang.org/t/how-to-create-a-macro-to-impl-a-provided-type-parametrized-trait/5289
for why this is implemented this way to support templatized traits.</p>
</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 = "downcast_rs";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>

1
doc/downcast_rs/sidebar-items.js Normal file
View File

@@ -0,0 +1 @@
initSidebarItems({"macro":[["impl_downcast","Adds downcasting support to traits that extend `downcast::Downcast` by defining forwarding methods to the corresponding implementations on `std::any::Any` in the standard library."]],"trait":[["Downcast","Supports conversion to `Any`. Traits to be extended by `impl_downcast!` must extend `Downcast`."]]});

16
doc/downcast_rs/trait.Downcast.html Normal file
View File

@@ -0,0 +1,16 @@
<!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 `Downcast` trait in crate `downcast_rs`."><meta name="keywords" content="rust, rustlang, rust-lang, Downcast"><title>downcast_rs::Downcast - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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><a href='../downcast_rs/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Downcast</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.as_any">as_any</a><a href="#tymethod.as_any_mut">as_any_mut</a><a href="#tymethod.into_any">into_any</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>downcast_rs</a></p><script>window.sidebarCurrent = {name: 'Downcast', ty: 'trait', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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/downcast_rs/lib.rs.html#124-134' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>downcast_rs</a>::<wbr><a class="trait" href=''>Downcast</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Downcast: <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> {
fn <a href='#tymethod.into_any' class='fnname'>into_any</a>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Self&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a>&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.as_any' class='fnname'>as_any</a>(&amp;self) -&gt; &amp;dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.as_any_mut' class='fnname'>as_any_mut</a>(&amp;mut self) -&gt; &amp;mut dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a>;
}</pre></div><div class='docblock'><p>Supports conversion to <code>Any</code>. Traits to be extended by <code>impl_downcast!</code> must extend <code>Downcast</code>.</p>
</div>
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.into_any' class='method'><code id='into_any.v'>fn <a href='#tymethod.into_any' class='fnname'>into_any</a>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Self&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a>&gt;</code></h3><div class='docblock'><p>Convert <code>Box&lt;Trait&gt;</code> (where <code>Trait: Downcast</code>) to <code>Box&lt;Any&gt;</code>. <code>Box&lt;Any&gt;</code> can then be
further <code>downcast</code> into <code>Box&lt;ConcreteType&gt;</code> where <code>ConcreteType</code> implements <code>Trait</code>.</p>
</div><h3 id='tymethod.as_any' class='method'><code id='as_any.v'>fn <a href='#tymethod.as_any' class='fnname'>as_any</a>(&amp;self) -&gt; &amp;dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a></code></h3><div class='docblock'><p>Convert <code>&amp;Trait</code> (where <code>Trait: Downcast</code>) to <code>&amp;Any</code>. This is needed since Rust cannot
generate <code>&amp;Any</code>'s vtable from <code>&amp;Trait</code>'s.</p>
</div><h3 id='tymethod.as_any_mut' class='method'><code id='as_any_mut.v'>fn <a href='#tymethod.as_any_mut' class='fnname'>as_any_mut</a>(&amp;mut self) -&gt; &amp;mut dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a></code></h3><div class='docblock'><p>Convert <code>&amp;mut Trait</code> (where <code>Trait: Downcast</code>) to <code>&amp;Any</code>. This is needed since Rust cannot
generate <code>&amp;mut Any</code>'s vtable from <code>&amp;mut Trait</code>'s.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-Downcast' class='impl'><code class='in-band'>impl&lt;T:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a>&gt; Downcast for T</code><a href='#impl-Downcast' class='anchor'></a><a class='srclink' href='../src/downcast_rs/lib.rs.html#136-140' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into_any' class="method hidden"><code id='into_any.v-1'>fn <a href='#method.into_any' class='fnname'>into_any</a>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Self&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a>&gt;</code><a class='srclink' href='../src/downcast_rs/lib.rs.html#137' title='goto source code'>[src]</a></h4><h4 id='method.as_any' class="method hidden"><code id='as_any.v-1'>fn <a href='#method.as_any' class='fnname'>as_any</a>(&amp;self) -&gt; &amp;dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a></code><a class='srclink' href='../src/downcast_rs/lib.rs.html#138' title='goto source code'>[src]</a></h4><h4 id='method.as_any_mut' class="method hidden"><code id='as_any_mut.v-1'>fn <a href='#method.as_any_mut' class='fnname'>as_any_mut</a>(&amp;mut self) -&gt; &amp;mut dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a></code><a class='srclink' href='../src/downcast_rs/lib.rs.html#139' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../implementors/downcast_rs/trait.Downcast.js">
</script></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 = "downcast_rs";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>