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 '2bc9ebdc6b'
${ noResults }
Trac3r-rust/doc/num/trait.CheckedMul.html

12 lines
24 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 `CheckedMul` trait in crate `num`."><meta name="keywords" content="rust, rustlang, rust-lang, CheckedMul"><title>num::CheckedMul - 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 CheckedMul</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.checked_mul">checked_mul</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-CheckedMul-for-i128">i128</a><a href="#impl-CheckedMul-for-i16">i16</a><a href="#impl-CheckedMul-for-i32">i32</a><a href="#impl-CheckedMul-for-i64">i64</a><a href="#impl-CheckedMul-for-i8">i8</a><a href="#impl-CheckedMul-for-isize">isize</a><a href="#impl-CheckedMul-for-u128">u128</a><a href="#impl-CheckedMul-for-u16">u16</a><a href="#impl-CheckedMul-for-u32">u32</a><a href="#impl-CheckedMul-for-u64">u64</a><a href="#impl-CheckedMul-for-u8">u8</a><a href="#impl-CheckedMul-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: 'CheckedMul', 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/ops/checked.rs.html#63-67' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>num</a>::<wbr><a class="trait" href=''>CheckedMul</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait CheckedMul: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Mul.html" title="trait core::ops::arith::Mul">Mul</a>&lt;Self, Output = Self&gt; {
fn <a href='#tymethod.checked_mul' class='fnname'>checked_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;;
}</pre></div><div class='docblock'><p>Performs multiplication that returns <code>None</code> instead of wrapping around on underflow or
overflow.</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.checked_mul' class='method'><code id='checked_mul.v'>fn <a href='#tymethod.checked_mul' class='fnname'>checked_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;</code></h3><div class='docblock'><p>Multiplies two numbers, checking for underflow or overflow. If underflow
or overflow happens, <code>None</code> is returned.</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-CheckedMul-for-i16' class='impl'><code class='in-band'>impl <a class="trait" href="../num/traits/ops/checked/trait.CheckedMul.html" title="trait num::traits::ops::checked::CheckedMul">CheckedMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></code><a href='#impl-CheckedMul-for-i16' class='anchor'></a><a class='srclink' href='../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_mul' class="method hidden"><code id='checked_mul.v-1'>fn <a href='#method.checked_mul' class='fnname'>checked_mul</a>(&amp;self, v: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>&gt;</code><a class='srclink' href='../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedMul-for-i8' class='impl'><code class='in-band'>impl <a class="trait" href="../num/traits/ops/checked/trait.CheckedMul.html" title="trait num::traits::ops::checked::CheckedMul">CheckedMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code><a href='#impl-CheckedMul-for-i8' class='anchor'></a><a class='srclink' href='../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_mul-1' class="method hidden"><code id='checked_mul.v-2'>fn <a href='#method.checked_mul' class='fnname'>checked_mul</a>(&amp;self, v: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>&gt;</code><a class='srclink' href='../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedMul-for-u64' class='impl'><code class='in-band'>impl <a class="trait" href="../num/traits/ops/checked/trait.CheckedMul.html" title="trait num::traits::ops::checked::CheckedMul">CheckedMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code><a href='#impl-CheckedMul-for-u64' class='anchor'></a><a class='srclink' href='../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_mul-2' class="method hidden"><code id='checked_mul.v-3'>fn <a href='#method.checked_mul' class='fnname'>checked_mul</a>(&amp;self, v: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>&gt;</code><a class='srclink' href='../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedMul-for-u8' class='impl'><code class='in-band'>impl <a class="trait" href="../num/traits/ops/checked/trait.CheckedMul.html" title="trait num::traits::ops::checked::CheckedMul">CheckedMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a href='#impl-CheckedMul-for-u8' class='anchor'></a><a class='srclink' href='../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_mul-3' class="method hidden"><code id='checked_mul.v-4'>fn <a href='#method.checked_mul' cl
<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-CheckedMul' class='impl'><code class='in-band'>impl CheckedMul for <a class="struct" href="../num/bigint/struct.BigInt.html" title="struct num::bigint::BigInt">BigInt</a></code><a href='#impl-CheckedMul' class='anchor'></a><a class='srclink' href='../src/num_bigint/bigint.rs.html#943-948' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_mul-12' class="method hidden"><code id='checked_mul.v-13'>fn <a href='#method.checked_mul-12' class='fnname'>checked_mul</a>(&amp;self, v: &amp;<a class="struct" href="../num/bigint/struct.BigInt.html" title="struct num::bigint::BigInt">BigInt</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../num/bigint/struct.BigInt.html" title="struct num::bigint::BigInt">BigInt</a>&gt;</code><a class='srclink' href='../src/num_bigint/bigint.rs.html#945-947' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedMul-1' class='impl'><code class='in-band'>impl CheckedMul for <a class="struct" href="../num/bigint/struct.BigUint.html" title="struct num::bigint::BigUint">BigUint</a></code><a href='#impl-CheckedMul-1' class='anchor'></a><a class='srclink' href='../src/num_bigint/biguint.rs.html#902-907' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_mul-13' class="method hidden"><code id='checked_mul.v-14'>fn <a href='#method.checked_mul-13' class='fnname'>checked_mul</a>(&amp;self, v: &amp;<a class="struct" href="../num/bigint/struct.BigUint.html" title="struct num::bigint::BigUint">BigUint</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../num/bigint/struct.BigUint.html" title="struct num::bigint::BigUint">BigUint</a>&gt;</code><a class='srclink' href='../src/num_bigint/biguint.rs.html#904-906' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedMul-2' class='impl'><code class='in-band'>impl&lt;T&gt; CheckedMul 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> + <a class="trait" href="../num/traits/ops/checked/trait.CheckedMul.html" title="trait num::traits::ops::checked::CheckedMul">CheckedMul</a>,&nbsp;</span></code><a href='#impl-CheckedMul-2' class='anchor'></a><a class='srclink' href='../src/num_rational/lib.rs.html#650-658' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_mul-14' class="method hidden"><code id='checked_mul.v-15'>fn <a href='#method.checked_mul-14' class='fnname'>checked_mul</a>(&amp;self, rhs: &amp;<a class="struct" href="../num/rational/struct.Ratio.html" title="struct num::rational::Ratio">Ratio</a>&lt;T&gt;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../num/rational/struct.Ratio.html" title="struct num::rational::Ratio">Ratio</a>&lt;T&gt;&gt;</code><a class='srclink' href='../src/num_rational/lib.rs.html#654-657' title='goto source code'>[src]</a></h4></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/ops/checked/trait.CheckedMul.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>