Files
tantivy/master/downcast/trait.Downcast.html
2018-05-03 07:28:39 +00:00

25 lines
14 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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`."><meta name="keywords" content="rust, rustlang, rust-lang, Downcast"><title>downcast::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></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><p class='location'>Trait Downcast</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.is_type">is_type</a><a href="#method.downcast_ref_unchecked">downcast_ref_unchecked</a><a href="#method.downcast_ref">downcast_ref</a><a href="#method.downcast_mut_unchecked">downcast_mut_unchecked</a><a href="#method.downcast_mut">downcast_mut</a><a href="#method.downcast_unchecked">downcast_unchecked</a><a href="#method.downcast">downcast</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>downcast</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"><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'>Trait <a href='index.html'>downcast</a>::<wbr><a class="trait" href=''>Downcast</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/downcast/lib.rs.html#117-160' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait Downcast&lt;T&gt;: <a class="trait" href="../downcast/trait.Any.html" title="trait downcast::Any">Any</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../downcast/trait.Any.html" title="trait downcast::Any">Any</a>,&nbsp;</span>{
fn <a href='#method.is_type' class='fnname'>is_type</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
<div class='item-spacer'></div> unsafe fn <a href='#method.downcast_ref_unchecked' class='fnname'>downcast_ref_unchecked</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T { ... }
<div class='item-spacer'></div> fn <a href='#method.downcast_ref' class='fnname'>downcast_ref</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T, <a class="struct" href="../downcast/struct.TypeMismatch.html" title="struct downcast::TypeMismatch">TypeMismatch</a>&gt; { ... }
<div class='item-spacer'></div> unsafe fn <a href='#method.downcast_mut_unchecked' class='fnname'>downcast_mut_unchecked</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T { ... }
<div class='item-spacer'></div> fn <a href='#method.downcast_mut' class='fnname'>downcast_mut</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T, <a class="struct" href="../downcast/struct.TypeMismatch.html" title="struct downcast::TypeMismatch">TypeMismatch</a>&gt; { ... }
<div class='item-spacer'></div> unsafe fn <a href='#method.downcast_unchecked' class='fnname'>downcast_unchecked</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;T&gt; { ... }
<div class='item-spacer'></div> fn <a href='#method.downcast' class='fnname'>downcast</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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;T&gt;, <a class="struct" href="../downcast/struct.DowncastError.html" title="struct downcast::DowncastError">DowncastError</a>&lt;<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;&gt; { ... }
}</pre></div>
<h2 id='provided-methods' class='small-section-header'>
Provided Methods<a href='#provided-methods' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='method.is_type' class='method'><span id='is_type.v' class='invisible'><code>fn <a href='#method.is_type' class='fnname'>is_type</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h3><h3 id='method.downcast_ref_unchecked' class='method'><span id='downcast_ref_unchecked.v' class='invisible'><code>unsafe fn <a href='#method.downcast_ref_unchecked' class='fnname'>downcast_ref_unchecked</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T</code></span></h3><h3 id='method.downcast_ref' class='method'><span id='downcast_ref.v' class='invisible'><code>fn <a href='#method.downcast_ref' class='fnname'>downcast_ref</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T, <a class="struct" href="../downcast/struct.TypeMismatch.html" title="struct downcast::TypeMismatch">TypeMismatch</a>&gt;</code></span></h3><h3 id='method.downcast_mut_unchecked' class='method'><span id='downcast_mut_unchecked.v' class='invisible'><code>unsafe fn <a href='#method.downcast_mut_unchecked' class='fnname'>downcast_mut_unchecked</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T</code></span></h3><h3 id='method.downcast_mut' class='method'><span id='downcast_mut.v' class='invisible'><code>fn <a href='#method.downcast_mut' class='fnname'>downcast_mut</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T, <a class="struct" href="../downcast/struct.TypeMismatch.html" title="struct downcast::TypeMismatch">TypeMismatch</a>&gt;</code></span></h3><h3 id='method.downcast_unchecked' class='method'><span id='downcast_unchecked.v' class='invisible'><code>unsafe fn <a href='#method.downcast_unchecked' class='fnname'>downcast_unchecked</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;T&gt;</code></span></h3><h3 id='method.downcast' class='method'><span id='downcast.v' class='invisible'><code>fn <a href='#method.downcast' class='fnname'>downcast</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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;T&gt;, <a class="struct" href="../downcast/struct.DowncastError.html" title="struct downcast::DowncastError">DowncastError</a>&lt;<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;&gt;</code></span></h3></div>
<h2 id='implementors' class='small-section-header'>
Implementors<a href='#implementors' class='anchor'></a>
</h2>
<ul class='item-list' id='implementors-list'>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;_T:&nbsp;<a class="trait" href="../downcast/trait.Any.html" title="trait downcast::Any">Any</a>&gt; Downcast&lt;_T&gt; for <a class="trait" href="../downcast/trait.Any.html" title="trait downcast::Any">Any</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;_T: <a class="trait" href="../downcast/trait.Any.html" title="trait downcast::Any">Any</a>,&nbsp;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/downcast/lib.rs.html#200-202' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;_T:&nbsp;<a class="trait" href="../downcast/trait.Any.html" title="trait downcast::Any">Any</a>&gt; Downcast&lt;_T&gt; for <a class="trait" href="../downcast/trait.Any.html" title="trait downcast::Any">Any</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;_T: <a class="trait" href="../downcast/trait.Any.html" title="trait downcast::Any">Any</a>,&nbsp;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/downcast/lib.rs.html#200-202' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;_T:&nbsp;<a class="trait" href="../downcast/trait.Any.html" title="trait downcast::Any">Any</a>&gt; Downcast&lt;_T&gt; for <a class="trait" href="../downcast/trait.Any.html" title="trait downcast::Any">Any</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;_T: <a class="trait" href="../downcast/trait.Any.html" title="trait downcast::Any">Any</a>,&nbsp;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/downcast/lib.rs.html#200-202' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;_T:&nbsp;<a class="trait" href="../downcast/trait.Any.html" title="trait downcast::Any">Any</a>&gt; Downcast&lt;_T&gt; for <a class="trait" href="../downcast/trait.Any.html" title="trait downcast::Any">Any</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;_T: <a class="trait" href="../downcast/trait.Any.html" title="trait downcast::Any">Any</a>,&nbsp;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/downcast/lib.rs.html#200-202' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../implementors/downcast/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";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>