mitchellhansen
/
Trac3r-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'da836f318e'
${ noResults }
Trac3r-rust/doc/num/trait.Num.html

26 lines
48 KiB
Raw Normal View History Unescape

add doc
5 years ago
<!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 `Num` trait in crate `num`."><meta name="keywords" content="rust, rustlang, rust-lang, Num"><title>num::Num - 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='../num/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Num</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.FromStrRadixErr">FromStrRadixErr</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.from_str_radix">from_str_radix</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Num-for-Wrapping%3CT%3E">Wrapping&lt;T&gt;</a><a href="#impl-Num-for-f32">f32</a><a href="#impl-Num-for-f64">f64</a><a href="#impl-Num-for-i128">i128</a><a href="#impl-Num-for-i16">i16</a><a href="#impl-Num-for-i32">i32</a><a href="#impl-Num-for-i64">i64</a><a href="#impl-Num-for-i8">i8</a><a href="#impl-Num-for-isize">isize</a><a href="#impl-Num-for-u128">u128</a><a href="#impl-Num-for-u16">u16</a><a href="#impl-Num-for-u32">u32</a><a href="#impl-Num-for-u64">u64</a><a href="#impl-Num-for-u8">u8</a><a href="#impl-Num-for-usize">usize</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>num</a></p><script>window.sidebarCurrent = {name: 'Num', 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/num_traits/lib.rs.html#62-79' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>num</a>::<wbr><a class="trait" href=''>Num</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Num: <a class="trait" href="../num/traits/identities/trait.Zero.html" title="trait num::traits::identities::Zero">Zero</a> + <a class="trait" href="../num/traits/identities/trait.One.html" title="trait num::traits::identities::One">One</a> + <a class="trait" href="../num/traits/trait.NumOps.html" title="trait num::traits::NumOps">
type <a href='#associatedtype.FromStrRadixErr' class="type">FromStrRadixErr</a>;
fn <a href='#tymethod.from_str_radix' class='fnname'>from_str_radix</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;str: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;radix: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, Self::<a class="type" href="../num/traits/trait.Num.html#associatedtype.FromStrRadixErr" title="type num::traits::Num::FromStrRadixErr">FromStrRadixErr</a>&gt;;
}</pre></div><div class='docblock'><p>The base trait for numeric types, covering <code>0</code> and <code>1</code> values,
comparisons, basic numeric operations, and string conversion.</p>
</div>
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.FromStrRadixErr' class='method'><code id='FromStrRadixErr.t'>type <a href='#associatedtype.FromStrRadixErr' class="type">FromStrRadixErr</a></code></h3></div><span class='loading-content'>Loading content...</span>
<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_str_radix' class='method'><code id='from_str_radix.v'>fn <a href='#tymethod.from_str_radix' class='fnname'>from_str_radix</a>(str: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, radix: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, Self::<a class="type" href="../num/traits/trait.Num.html#associatedtype.FromStrRadixErr" title="type num::traits::Num::FromStrRadixErr">FromStrRadixErr</a>&gt;</code></h3><div class='docblock'><p>Convert from a string and radix &lt;= 36.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">Num</span>;
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="op">&lt;</span><span class="ident">i32</span> <span class="kw">as</span> <span class="ident">Num</span><span class="op">&gt;</span>::<span class="ident">from_str_radix</span>(<span class="string">&quot;27&quot;</span>, <span class="number">10</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>, <span class="prelude-val">Ok</span>(<span class="number">27</span>));
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="op">&lt;</span><span class="ident">i32</span> <span class="kw">as</span> <span class="ident">Num</span><span class="op">&gt;</span>::<span class="ident">from_str_radix</span>(<span class="string">&quot;foo&quot;</span>, <span class="number">10</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());</pre></div>
</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-Num-for-i8' class='impl'><code class='in-band'>impl <a class="trait" href="../num/traits/trait.Num.html" title="trait num::traits::Num">Num</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code><a href='#impl-Num-for-i8' class='anchor'></a><a class='srclink' href='../src/num_traits/lib.rs.html#144-152' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.FromStrRadixErr-1' class="type"><code id='FromStrRadixErr.t-1'>type <a href='#associatedtype.FromStrRadixErr' class="type">FromStrRadixErr</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str_radix' class="method hidden"><code id='from_str_radix.v-1'>fn <a href='#method.from_str_radix' class='fnname'>from_str_radix</a>(s: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, radix: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&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.i8.html">i8</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a>&gt;</code><a class='srclink' href='../src/num_traits/lib.rs.html#147-151' title='goto source code'>[src]</a></h4></div><h3 id='impl-Num-for-i16' class='impl'><code class='in-band'>impl <a class="trait" href="../num/traits/trait.Num.html" title="trait num::traits::Num">Num</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></code><a href='#impl-Num-for-i16' class='anchor'></a><a class='srclink' href='../src/num_traits/lib.rs.html#144-152' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.FromStrRadixErr-2' class="type"><code id='FromStrRadixErr.t-2'>type <a href='#associatedtype.FromStrRadixErr' class="type">FromStrRadixErr</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str_radix-1' class="method hidden"><code id='from_str_radix.v-2'>fn <a href='#method.from_str_radix' class='fnname'>from_str_radix</a>(s: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, radix: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&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.i16.html">i16</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a>&gt;</code><a class='srclink' href='../src/num_traits/lib.rs.html#147-151' title='goto source code'>[src]</a></h4></div><h3 id='impl-Num-for-u64' class='impl'><code class='in-band'>impl <a class="trait" href="../num/traits/trait.Num.html" title="trait num::traits::Num">Num</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code><a href='#impl-Num-for-u64' class='anchor'></a><a class='srclink' href='../src/num_traits/lib.rs.html#144-152' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.FromStrRadixErr-3' class="type"><code id='FromStrRadixErr.t-3'>type <a href='#associatedtype.FromStrRadixErr' class="type">FromStrRadixErr</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" tit
<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-Num' class='impl'><code class='in-band'>impl Num for <a class="struct" href="../num/bigint/struct.BigInt.html" title="struct num::bigint::BigInt">BigInt</a></code><a href='#impl-Num' class='anchor'></a><a class='srclink' href='../src/num_bigint/bigint.rs.html#193-211' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.FromStrRadixErr-16' class="type"><code id='FromStrRadixErr.t-16'>type <a href='#associatedtype.FromStrRadixErr-16' class="type">FromStrRadixErr</a> = <a class="enum" href="../num/bigint/enum.ParseBigIntError.html" title="enum num::bigint::ParseBigIntError">ParseBigIntError</a></code></h4><h4 id='method.from_str_radix-15' class="method"><code id='from_str_radix.v-16'>fn <a href='#method.from_str_radix-15' class='fnname'>from_str_radix</a>(s: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, radix: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&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="../num/bigint/struct.BigInt.html" title="struct num::bigint::BigInt">BigInt</a>, <a class="enum" href="../num/bigint/enum.ParseBigIntError.html" title="enum num::bigint::ParseBigIntError">ParseBigIntError</a>&gt;</code><a class='srclink' href='../src/num_bigint/bigint.rs.html#198-210' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates and initializes a BigInt.</p>
</div></div><h3 id='impl-Num-1' class='impl'><code class='in-band'>impl Num for <a class="struct" href="../num/bigint/struct.BigUint.html" title="struct num::bigint::BigUint">BigUint</a></code><a href='#impl-Num-1' class='anchor'></a><a class='srclink' href='../src/num_bigint/biguint.rs.html#221-283' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.FromStrRadixErr-17' class="type"><code id='FromStrRadixErr.t-17'>type <a href='#associatedtype.FromStrRadixErr-17' class="type">FromStrRadixErr</a> = <a class="enum" href="../num/bigint/enum.ParseBigIntError.html" title="enum num::bigint::ParseBigIntError">ParseBigIntError</a></code></h4><h4 id='method.from_str_radix-16' class="method"><code id='from_str_radix.v-17'>fn <a href='#method.from_str_radix-16' class='fnname'>from_str_radix</a>(s: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, radix: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&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="../num/bigint/struct.BigUint.html" title="struct num::bigint::BigUint">BigUint</a>, <a class="enum" href="../num/bigint/enum.ParseBigIntError.html" title="enum num::bigint::ParseBigIntError">ParseBigIntError</a>&gt;</code><a class='srclink' href='../src/num_bigint/biguint.rs.html#225-282' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates and initializes a <code>BigUint</code>.</p>
</div></div><h3 id='impl-Num-2' class='impl'><code class='in-band'>impl&lt;T&gt; Num for <a class="struct" href="../num/complex/struct.Complex.html" title="struct num::complex::Complex">Complex</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="../num/traits/trait.Num.html" title="trait num::traits::Num">Num</a>,&nbsp;</span></code><a href='#impl-Num-2' class='anchor'></a><a class='srclink' href='../src/num_complex/lib.rs.html#1042-1051' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.FromStrRadixErr-18' class="type"><code id='FromStrRadixErr.t-18'>type <a href='#associatedtype.FromStrRadixErr-18' class="type">FromStrRadixErr</a> = <a class="struct" href="../num/complex/struct.ParseComplexError.html" title="struct num::complex::ParseComplexError">ParseComplexError</a>&lt;&lt;T as <a class="trait" href="../num/traits/trait.Num.html" title="trait num::traits::Num">Num</a>&gt;::<a class="type" href="../num/traits/trait.Num.html#associatedtype.FromStrRadixErr" title="type num::traits::Num::FromStrRadixErr">FromStrRadixErr</a>&gt;</code></h4><h4 id='method.from_str_radix-17' class="method"><code id='from_str_radix.v-18'>fn <a href='#method.from_str_radix-17' class='fnname'>from_str_radix</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;s: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;radix: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>) -&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="../num/complex/struct.Complex.html" title="struct num::complex::Complex">Complex</a>&lt;T&gt;, &lt;<a class="struct" href="../num/complex/struct.Complex.html" title="struct num::complex::Complex">Complex</a>&lt;T&gt; as <a class="trait" href="../num/traits/trait.Num.html" title="trait num::traits::Num">Num</a>&gt;::<a class="type" href="../num/traits/trait.Num.html#associatedtype.FromStrRadixErr" title="type num::traits::Num::FromStrRadixErr">FromStrRadixErr</a>&gt;</code><a class='srclink' href='../src/num_complex/lib.rs.html#1046-1050' title='goto source code'>[src]</a></h4><div class='docblock'><p>Parses <code>a +/- bi</code>; <code>ai +/- b</code>; <code>a</code>; or <code>bi</code> where <code>a</code> and <code>b</code> are of type <code>T</code></p>
</div></div><h3 id='impl-Num-3' class='impl'><code class='in-band'>impl&lt;T&gt; Num for <a class="struct" href="../num/rational/struct.Ratio.html" title="struct num::rational::Ratio">Ratio</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="../num/integer/trait.Integer.html" title="trait num::integer::Integer">Integer</a>,&nbsp;</span></code><a href='#impl-Num-3' class='anchor'></a><a class='srclink' href='../src/num_rational/lib.rs.html#738-764' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.FromStrRadixErr-19' class="type"><code id='FromStrRadixErr.t-19'>type <a href='#associatedtype.FromStrRadixErr-19' class="type">FromStrRadixErr</a> = <a class="struct" href="../num/rational/struct.ParseRatioError.html" title="struct num::rational::ParseRatioError">ParseRatioError</a></code></h4><h4 id='method.from_str_radix-18' class="method"><code id='from_str_radix.v-19'>fn <a href='#method.from_str_radix-18' class='fnname'>from_str_radix</a>(s: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, radix: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&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="../num/rational/struct.Ratio.html" title="struct num::rational::Ratio">Ratio</a>&lt;T&gt;, <a class="struct" href="../num/rational/struct.ParseRatioError.html" title="struct num::rational::ParseRatioError">ParseRatioError</a>&gt;</code><a class='srclink' href='../src/num_rational/lib.rs.html#742-763' title='goto source code'>[src]</a></h4><div class='docblock'><p>Parses <code>numer/denom</code> where the numbers are in base <code>radix</code>.</p>
</div></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/num_traits/trait.Num.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 = "num";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>