github-actions[bot]
18 lines
18 KiB
HTML
18 lines
18 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 `NumCast` trait in crate `num_traits`."><meta name="keywords" content="rust, rustlang, rust-lang, NumCast"><title>num_traits::cast::NumCast - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><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">☰</div><a href='../../num_traits/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait NumCast</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.from">from</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-NumCast-for-Wrapping%3CT%3E">Wrapping<T></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">num_traits</a>::<wbr><a href="index.html">cast</a></p><script>window.sidebarCurrent = {name: "NumCast", 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!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<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">−</span>]</a></span><a class="srclink" href="../../src/num_traits/cast.rs.html#691-705" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../index.html">num_traits</a>::<wbr><a href="index.html">cast</a>::<wbr><a class="trait" href="">NumCast</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait NumCast: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a> {
|
||
fn <a href="#tymethod.from" class="fnname">from</a><T: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
||
}</pre></div><div class="docblock"><p>An interface for casting between machine scalars.</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.from" class="method"><code>fn <a href="#tymethod.from" class="fnname">from</a><T: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></code><a class="srclink" href="../../src/num_traits/cast.rs.html#704" title="goto source code">[src]</a></h3><div class="docblock"><p>Creates a number from another value that can be converted into
|
||
a primitive via the <code>ToPrimitive</code> trait. If the source value cannot be
|
||
represented by the target type, then <code>None</code> is returned.</p>
|
||
<p>A value can be represented by the target type when it lies within
|
||
the range of scalars supported by the target type.
|
||
For example, a negative integer cannot be represented by an unsigned
|
||
integer type, and an <code>i64</code> with a very high magnitude might not be
|
||
convertible to an <code>i32</code>.
|
||
On the other hand, conversions with possible precision loss or truncation
|
||
are admitted, like an <code>f32</code> with a decimal part to an integer type, or
|
||
even a large <code>f64</code> saturating to <code>f32</code> infinity.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-NumCast-for-Wrapping%3CT%3E" class="impl"><code class="in-band">impl<T: <a class="trait" href="../../num_traits/cast/trait.NumCast.html" title="trait num_traits::cast::NumCast">NumCast</a>> <a class="trait" href="../../num_traits/cast/trait.NumCast.html" title="trait num_traits::cast::NumCast">NumCast</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a><T></code><a href="#impl-NumCast-for-Wrapping%3CT%3E" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#738-742" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>fn <a href="#method.from" class="fnname">from</a><U: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></code><a class="srclink" href="../../src/num_traits/cast.rs.html#739-741" title="goto source code">[src]</a></h4></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-NumCast" class="impl"><code class="in-band">impl NumCast for f32</code><a href="#impl-NumCast" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#735" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-1" class="method hidden"><code>fn <a href="#method.from-1" class="fnname">from</a><N: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: N) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><f32></code><a class="srclink" href="../../src/num_traits/cast.rs.html#735" title="goto source code">[src]</a></h4></div><h3 id="impl-NumCast-1" class="impl"><code class="in-band">impl NumCast for f64</code><a href="#impl-NumCast-1" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#736" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-2" class="method hidden"><code>fn <a href="#method.from-2" class="fnname">from</a><N: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: N) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><f64></code><a class="srclink" href="../../src/num_traits/cast.rs.html#736" title="goto source code">[src]</a></h4></div><h3 id="impl-NumCast-2" class="impl"><code class="in-band">impl NumCast for i8</code><a href="#impl-NumCast-2" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#728" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-3" class="method hidden"><code>fn <a href="#method.from-3" class="fnname">from</a><N: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: N) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><i8></code><a class="srclink" href="../../src/num_traits/cast.rs.html#728" title="goto source code">[src]</a></h4></div><h3 id="impl-NumCast-3" class="impl"><code class="in-band">impl NumCast for i16</code><a href="#impl-NumCast-3" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#729" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-4" class="method hidden"><code>fn <a href="#method.from-4" class="fnname">from</a><N: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: N) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><i16></code><a class="srclink" href="../../src/num_traits/cast.rs.html#729" title="goto source code">[src]</a></h4></div><h3 id="impl-NumCast-4" class="impl"><code class="in-band">impl NumCast for i32</code><a href="#impl-NumCast-4" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#730" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-5" class="method hidden"><code>fn <a href="#method.from-5" class="fnname">from</a><N: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: N) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><i32></code><a class="srclink" href="../../src/num_traits/cast.rs.html#730" title="goto source code">[src]</a></h4></div><h3 id="impl-NumCast-5" class="impl"><code class="in-band">impl NumCast for i64</code><a href="#impl-NumCast-5" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#731" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-6" class="method hidden"><code>fn <a href="#method.from-6" class="fnname">from</a><N: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: N) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><i64></code><a class="srclink" href="../../src/num_traits/cast.rs.html#731" title="goto source code">[src]</a></h4></div><h3 id="impl-NumCast-6" class="impl"><code class="in-band">impl NumCast for i128</code><a href="#impl-NumCast-6" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#733" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-7" class="method hidden"><code>fn <a href="#method.from-7" class="fnname">from</a><N: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: N) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><i128></code><a class="srclink" href="../../src/num_traits/cast.rs.html#733" title="goto source code">[src]</a></h4></div><h3 id="impl-NumCast-7" class="impl"><code class="in-band">impl NumCast for isize</code><a href="#impl-NumCast-7" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#734" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-8" class="method hidden"><code>fn <a href="#method.from-8" class="fnname">from</a><N: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: N) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><isize></code><a class="srclink" href="../../src/num_traits/cast.rs.html#734" title="goto source code">[src]</a></h4></div><h3 id="impl-NumCast-8" class="impl"><code class="in-band">impl NumCast for u8</code><a href="#impl-NumCast-8" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#721" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-9" class="method hidden"><code>fn <a href="#method.from-9" class="fnname">from</a><N: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: N) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><u8></code><a class="srclink" href="../../src/num_traits/cast.rs.html#721" title="goto source code">[src]</a></h4></div><h3 id="impl-NumCast-9" class="impl"><code class="in-band">impl NumCast for u16</code><a href="#impl-NumCast-9" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#722" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-10" class="method hidden"><code>fn <a href="#method.from-10" class="fnname">from</a><N: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: N) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><u16></code><a class="srclink" href="../../src/num_traits/cast.rs.html#722" title="goto source code">[src]</a></h4></div><h3 id="impl-NumCast-10" class="impl"><code class="in-band">impl NumCast for u32</code><a href="#impl-NumCast-10" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#723" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-11" class="method hidden"><code>fn <a href="#method.from-11" class="fnname">from</a><N: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: N) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><u32></code><a class="srclink" href="../../src/num_traits/cast.rs.html#723" title="goto source code">[src]</a></h4></div><h3 id="impl-NumCast-11" class="impl"><code class="in-band">impl NumCast for u64</code><a href="#impl-NumCast-11" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#724" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-12" class="method hidden"><code>fn <a href="#method.from-12" class="fnname">from</a><N: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: N) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><u64></code><a class="srclink" href="../../src/num_traits/cast.rs.html#724" title="goto source code">[src]</a></h4></div><h3 id="impl-NumCast-12" class="impl"><code class="in-band">impl NumCast for u128</code><a href="#impl-NumCast-12" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#726" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-13" class="method hidden"><code>fn <a href="#method.from-13" class="fnname">from</a><N: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: N) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><u128></code><a class="srclink" href="../../src/num_traits/cast.rs.html#726" title="goto source code">[src]</a></h4></div><h3 id="impl-NumCast-13" class="impl"><code class="in-band">impl NumCast for usize</code><a href="#impl-NumCast-13" class="anchor"></a><a class="srclink" href="../../src/num_traits/cast.rs.html#727" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-14" class="method hidden"><code>fn <a href="#method.from-14" class="fnname">from</a><N: <a class="trait" href="../../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>>(n: N) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><usize></code><a class="srclink" href="../../src/num_traits/cast.rs.html#727" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/num_traits/cast/trait.NumCast.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "num_traits";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |