mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-07 04:26:39 +00:00
41 lines
294 KiB
HTML
41 lines
294 KiB
HTML
|
<!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 `AsPrimitive` trait in crate `num_traits`."><meta name="keywords" content="rust, rustlang, rust-lang, AsPrimitive"><title>num_traits::AsPrimitive - 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">☰</div><p class='location'>Trait AsPrimitive</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_">as_</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-AsPrimitive%3Cf32%3E">i16</a><a href="#impl-AsPrimitive%3Ci8%3E">char</a><a href="#impl-AsPrimitive%3Ci64%3E">i16</a><a href="#impl-AsPrimitive%3Ci8%3E">i64</a><a href="#impl-AsPrimitive%3Ci8%3E">f32</a><a href="#impl-AsPrimitive%3Cu8%3E">char</a><a href="#impl-AsPrimitive%3Ci64%3E">u8</a><a href="#impl-AsPrimitive%3Cu16%3E">char</a><a href="#impl-AsPrimitive%3Cf64%3E">i32</a><a href="#impl-AsPrimitive%3Ci128%3E">u16</a><a href="#impl-AsPrimitive%3Cusize%3E">u16</a><a href="#impl-AsPrimitive%3Cu32%3E">i8</a><a href="#impl-AsPrimitive%3Cisize%3E">u32</a><a href="#impl-AsPrimitive%3Ci128%3E">i128</a><a href="#impl-AsPrimitive%3Cu32%3E">u16</a><a href="#impl-AsPrimitive%3Cusize%3E">u8</a><a href="#impl-AsPrimitive%3Cisize%3E">u128</a><a href="#impl-AsPrimitive%3Ci8%3E">u64</a><a href="#impl-AsPrimitive%3Cf64%3E">f32</a><a href="#impl-AsPrimitive%3Ci32%3E">i32</a><a href="#impl-AsPrimitive%3Cu16%3E">f32</a><a href="#impl-AsPrimitive%3Cu128%3E">i128</a><a href="#impl-AsPrimitive%3Cu32%3E">i128</a><a href="#impl-AsPrimitive%3Ci8%3E">i32</a><a href="#impl-AsPrimitive%3Ci8%3E">i8</a><a href="#impl-AsPrimitive%3Ci8%3E">usize</a><a href="#impl-AsPrimitive%3Cusize%3E">isize</a><a href="#impl-AsPrimitive%3Cu8%3E">i64</a><a href="#impl-AsPrimitive%3Cu16%3E">u32</a><a href="#impl-AsPrimitive%3Cu8%3E">bool</a><a href="#impl-AsPrimitive%3Cu32%3E">isize</a><a href="#impl-AsPrimitive%3Cusize%3E">f32</a><a href="#impl-AsPrimitive%3Cu32%3E">char</a><a href="#impl-AsPrimitive%3Cu32%3E">u32</a><a href="#impl-AsPrimitive%3Cu32%3E">usize</a><a href="#impl-AsPrimitive%3Cu64%3E">usize</a><a href="#impl-AsPrimitive%3Cisize%3E">isize</a><a href="#impl-AsPrimitive%3Cusize%3E">i128</a><a href="#impl-AsPrimitive%3Cu16%3E">i8</a><a href="#impl-AsPrimitive%3Cf64%3E">i8</a><a href="#impl-AsPrimitive%3Cu64%3E">u8</a><a href="#impl-AsPrimitive%3Cu16%3E">usize</a><a href="#impl-AsPrimitive%3Ci16%3E">bool</a><a href="#impl-AsPrimitive%3Cf64%3E">i16</a><a href="#impl-AsPrimitive%3Cchar%3E">u8</a><a href="#impl-AsPrimitive%3Cisize%3E">u8</a><a href="#impl-AsPrimitive%3Cf64%3E">f64</a><a href="#impl-AsPrimitive%3Cusize%3E">i8</a><a href="#impl-AsPrimitive%3Cu128%3E">u16</a><a href="#impl-AsPrimitive%3Cu8%3E">u64</a><a href="#impl-AsPrimitive%3Ci16%3E">i8</a><a href="#impl-AsPrimitive%3Cf64%3E">u128</a><a href="#impl-AsPrimitive%3Cu16%3E">i16</a><a href="#impl-AsPrimitive%3Cu128%3E">u64</a><a href="#impl-AsPrimitive%3Cf32%3E">i64</a><a href="#impl-AsPrimitive%3Ci8%3E">bool</a><a href="#impl-AsPrimitive%3Ci32%3E">u8</a><a href="#impl-AsPrimitive%3Ci32%3E">u16</a><a href="#impl-AsPrimitive%3Cu8%3E">i128</a><a href="#impl-AsPrimitive%3Cu128%3E">u32</a><a href="#impl-AsPrimitive%3Cu16%3E">f64</a><a href="#impl-AsPrimitive%3Ci16%3E">isize</a><a href="#impl-AsPrimitive%3Ci8%3E">u128</a><a href="#impl-AsPr
|
||
|
|
fn <a href='#tymethod.as_' class='fnname'>as_</a>(self) -> T;
|
||
|
|
}</pre></div><div class='docblock'><p>A generic interface for casting between machine scalars with the
|
||
|
|
<code>as</code> operator, which admits narrowing and precision loss.
|
||
|
|
Implementers of this trait AsPrimitive should behave like a primitive
|
||
|
|
numeric type (e.g. a newtype around another primitive), and the
|
||
|
|
intended conversion must never fail.</p>
|
||
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
|
|
<pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">let</span> <span class="ident">three</span>: <span class="ident">i32</span> <span class="op">=</span> (<span class="number">3.14159265f32</span>).<span class="ident">as_</span>();
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">three</span>, <span class="number">3</span>);</pre>
|
||
|
|
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
||
|
|
<p>Currently, some uses of the <code>as</code> operator are not entirely safe.
|
||
|
|
In particular, it is undefined behavior if:</p>
|
||
|
|
<ul>
|
||
|
|
<li>A truncated floating point value cannot fit in the target integer
|
||
|
|
type (<a href="https://github.com/rust-lang/rust/issues/10184">#10184</a>);</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
|
||
|
|
<span class="kw">let</span> <span class="ident">x</span>: <span class="ident">u8</span> <span class="op">=</span> (<span class="number">1.04E+17</span>).<span class="ident">as_</span>(); <span class="comment">// UB</span></pre>
|
||
|
|
<ul>
|
||
|
|
<li>Or a floating point value does not fit in another floating
|
||
|
|
point type (<a href="https://github.com/rust-lang/rust/issues/15536">#15536</a>).</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
|
||
|
|
<span class="kw">let</span> <span class="ident">x</span>: <span class="ident">f32</span> <span class="op">=</span> (<span class="number">1e300f64</span>).<span class="ident">as_</span>(); <span class="comment">// UB</span></pre>
|
||
|
|
</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.as_' class='method'><span id='as_.v' class='invisible'><code>fn <a href='#tymethod.as_' class='fnname'>as_</a>(self) -> T</code></span></h3><div class='docblock'><p>Convert a value to another, using the <code>as</code> operator.</p>
|
||
|
|
</div></div>
|
||
|
|
<h2 id='foreign-impls' class='small-section-header'>
|
||
|
|
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
||
|
|
</h2>
|
||
|
|
<h3 id='impl-AsPrimitive%3Cf32%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../num_traits/cast/trait.AsPrimitive.html" title="trait num_traits::cast::AsPrimitive">AsPrimitive</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></code><a href='#impl-AsPrimitive%3Cf32%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/cast.rs.html#729-731' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.as_' class="method"><span id='as_.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.as_' class='fnname'>as_</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/cast.rs.html#730' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-AsPrimitive%3Ci8%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../num_traits/cast/trait.AsPrimitive.html" title="trait num_traits::cast::AsPrimitive">AsPrimitive</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a></code><a href='#impl-AsPrimitive%3Ci8%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/cast.rs.html#729-731' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.as_-1' class="method"><span id='as_.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.as_' class='fnname'>as_</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/cast.rs.html#730' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-AsPrimitive%3Ci64%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../num_traits/cast/trait.AsPrimitive.html" title="trait num_traits::cast::AsPrimitive">AsPrimitive</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></code><a href='#impl-AsPrimitive%3Ci64%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/cast.rs.html#729-731' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.as_-2' class="method"><span id='as_.v-3' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.as_' class='fnname'>as_</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/cast.rs.html#730' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-AsPrimitive%3Ci8%3E-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../num_traits/cast/trait.AsPrimitive.html" title="trait num_traits::cast::AsPrimitive">AsPrimitive</a><<a class="primitive" href="https://d
|
||
|
|
src="../implementors/num_traits/cast/trait.AsPrimitive.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>⏎</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 = "num_traits";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|