mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-20 10:10:42 +00:00
178 lines
18 KiB
HTML
178 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 `Num` trait in crate `num_traits`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Num">
|
||
|
||
<title>num_traits::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="../main.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 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">Wrapping<T></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>num_traits</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">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content">
|
||
<h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>num_traits</a>::<wbr><a class="trait" href=''>Num</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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../src/num_traits/lib.rs.html#61-79' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust trait'>pub trait Num: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> + <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">NumOps</a> {
|
||
type <a href='#associatedtype.FromStrRadixErr' class="type">FromStrRadixErr</a>;
|
||
fn <a href='#tymethod.from_str_radix' class='fnname'>from_str_radix</a>(<br> str: &str, <br> radix: u32<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="../num_traits/trait.Num.html#associatedtype.FromStrRadixErr" title="type num_traits::Num::FromStrRadixErr">FromStrRadixErr</a>>;
|
||
}</pre><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'><span id='FromStrRadixErr.t' class='invisible'><code>type <a href='#associatedtype.FromStrRadixErr' class="type">FromStrRadixErr</a></code></span></h3></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_str_radix' class='method'><span id='from_str_radix.v' class='invisible'><code>fn <a href='#tymethod.from_str_radix' class='fnname'>from_str_radix</a>(str: &str, radix: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="../num_traits/trait.Num.html#associatedtype.FromStrRadixErr" title="type num_traits::Num::FromStrRadixErr">FromStrRadixErr</a>></code></span></h3><div class='docblock'><p>Convert from a string and radix <= 36.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<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"><</span><span class="ident">i32</span> <span class="kw">as</span> <span class="ident">Num</span><span class="op">></span>::<span class="ident">from_str_radix</span>(<span class="string">"27"</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"><</span><span class="ident">i32</span> <span class="kw">as</span> <span class="ident">Num</span><span class="op">></span>::<span class="ident">from_str_radix</span>(<span class="string">"foo"</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>
|
||
<h2 id='foreign-impls' class='small-section-header'>
|
||
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-Num' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a>> <a class="trait" href="../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a><T> <span class="where fmt-newline">where<br> <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a><T>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a><Output = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a><T>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Sub.html" title="trait core::ops::arith::Sub">Sub</a><Output = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a><T>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Mul.html" title="trait core::ops::arith::Mul">Mul</a><Output = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a><T>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Div.html" title="trait core::ops::arith::Div">Div</a><Output = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a><T>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Rem.html" title="trait core::ops::arith::Rem">Rem</a><Output = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a><T>>, </span></code><a href='#impl-Num' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/lib.rs.html#162-171' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.FromStrRadixErr-1' class="type"><span id='FromStrRadixErr.t-1' class='invisible'><code>type <a href='#associatedtype.FromStrRadixErr' class="type">FromStrRadixErr</a> = T::<a class="type" href="../num_traits/trait.Num.html#associatedtype.FromStrRadixErr" title="type num_traits::Num::FromStrRadixErr">FromStrRadixErr</a></code></span></h4>
|
||
<h4 id='method.from_str_radix' class="method"><span id='from_str_radix.v-1' class='invisible'><code>fn <a href='#method.from_str_radix' class='fnname'>from_str_radix</a>(str: &str, radix: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="../num_traits/trait.Num.html#associatedtype.FromStrRadixErr" title="type num_traits::Num::FromStrRadixErr">FromStrRadixErr</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/lib.rs.html#168-170' title='goto source code'>[src]</a></span></h4>
|
||
</div></span>
|
||
<h2 id='implementors' class='small-section-header'>
|
||
Implementors<a href='#implementors' class='anchor'></a>
|
||
</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><div class='out-of-band'><a class='srclink' href='../src/num_traits/lib.rs.html#149-157' title='goto source code'>[src]</a></div><code>impl Num for usize<span class="where fmt-newline"> 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>;</span></code></li>
|
||
<li><div class='out-of-band'><a class='srclink' href='../src/num_traits/lib.rs.html#149-157' title='goto source code'>[src]</a></div><code>impl Num for u8<span class="where fmt-newline"> 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>;</span></code></li>
|
||
<li><div class='out-of-band'><a class='srclink' href='../src/num_traits/lib.rs.html#149-157' title='goto source code'>[src]</a></div><code>impl Num for u16<span class="where fmt-newline"> 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>;</span></code></li>
|
||
<li><div class='out-of-band'><a class='srclink' href='../src/num_traits/lib.rs.html#149-157' title='goto source code'>[src]</a></div><code>impl Num for u32<span class="where fmt-newline"> 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>;</span></code></li>
|
||
<li><div class='out-of-band'><a class='srclink' href='../src/num_traits/lib.rs.html#149-157' title='goto source code'>[src]</a></div><code>impl Num for u64<span class="where fmt-newline"> 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>;</span></code></li>
|
||
<li><div class='out-of-band'><a class='srclink' href='../src/num_traits/lib.rs.html#149-157' title='goto source code'>[src]</a></div><code>impl Num for isize<span class="where fmt-newline"> 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>;</span></code></li>
|
||
<li><div class='out-of-band'><a class='srclink' href='../src/num_traits/lib.rs.html#149-157' title='goto source code'>[src]</a></div><code>impl Num for i8<span class="where fmt-newline"> 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>;</span></code></li>
|
||
<li><div class='out-of-band'><a class='srclink' href='../src/num_traits/lib.rs.html#149-157' title='goto source code'>[src]</a></div><code>impl Num for i16<span class="where fmt-newline"> 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>;</span></code></li>
|
||
<li><div class='out-of-band'><a class='srclink' href='../src/num_traits/lib.rs.html#149-157' title='goto source code'>[src]</a></div><code>impl Num for i32<span class="where fmt-newline"> 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>;</span></code></li>
|
||
<li><div class='out-of-band'><a class='srclink' href='../src/num_traits/lib.rs.html#149-157' title='goto source code'>[src]</a></div><code>impl Num for i64<span class="where fmt-newline"> 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>;</span></code></li>
|
||
<li><div class='out-of-band'><a class='srclink' href='../src/num_traits/lib.rs.html#202-353' title='goto source code'>[src]</a></div><code>impl Num for f32<span class="where fmt-newline"> type <a href='#associatedtype.FromStrRadixErr' class="type">FromStrRadixErr</a> = <a class="struct" href="../num_traits/struct.ParseFloatError.html" title="struct num_traits::ParseFloatError">ParseFloatError</a>;</span></code></li>
|
||
<li><div class='out-of-band'><a class='srclink' href='../src/num_traits/lib.rs.html#202-353' title='goto source code'>[src]</a></div><code>impl Num for f64<span class="where fmt-newline"> type <a href='#associatedtype.FromStrRadixErr' class="type">FromStrRadixErr</a> = <a class="struct" href="../num_traits/struct.ParseFloatError.html" title="struct num_traits::ParseFloatError">ParseFloatError</a>;</span></code></li>
|
||
</ul><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>⏎</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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../";
|
||
window.currentCrate = "num_traits";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |