173 lines
No EOL
22 KiB
HTML
173 lines
No EOL
22 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 `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="../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 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">usize</a><a href="#impl-CheckedMul">u32</a><a href="#impl-CheckedMul">i8</a><a href="#impl-CheckedMul">i32</a><a href="#impl-CheckedMul">isize</a><a href="#impl-CheckedMul">u16</a><a href="#impl-CheckedMul">u8</a><a href="#impl-CheckedMul">u64</a><a href="#impl-CheckedMul">i64</a><a href="#impl-CheckedMul">i16</a><a href="#impl-CheckedMul">Ratio<T></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">
|
||
<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</a>::<wbr><a class="trait" href=''>CheckedMul</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/ops/checked.rs.html#63-67' title='goto source code'>[src]</a></span></h1>
|
||
<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><Self, Output = Self> {
|
||
fn <a href='#tymethod.checked_mul' class='fnname'>checked_mul</a>(&self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <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 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'><span id='checked_mul.v' class='invisible'><code>fn <a href='#tymethod.checked_mul' class='fnname'>checked_mul</a>(&self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></code></span></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>
|
||
<h2 id='foreign-impls' class='small-section-header'>
|
||
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-CheckedMul' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num/trait.CheckedMul.html" title="trait num::CheckedMul">CheckedMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a href='#impl-CheckedMul' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_mul' class="method"><span id='checked_mul.v-1' class='invisible'><code>fn <a href='#method.checked_mul' class='fnname'>checked_mul</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedMul-1' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num/trait.CheckedMul.html" title="trait num::CheckedMul">CheckedMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a href='#impl-CheckedMul-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_mul-1' class="method"><span id='checked_mul.v-2' class='invisible'><code>fn <a href='#method.checked_mul' class='fnname'>checked_mul</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedMul-2' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num/trait.CheckedMul.html" title="trait num::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-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_mul-2' class="method"><span id='checked_mul.v-3' class='invisible'><code>fn <a href='#method.checked_mul' class='fnname'>checked_mul</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedMul-3' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num/trait.CheckedMul.html" title="trait num::CheckedMul">CheckedMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code><a href='#impl-CheckedMul-3' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_mul-3' class="method"><span id='checked_mul.v-4' class='invisible'><code>fn <a href='#method.checked_mul' class='fnname'>checked_mul</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedMul-4' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num/trait.CheckedMul.html" title="trait num::CheckedMul">CheckedMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></code><a href='#impl-CheckedMul-4' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_mul-4' class="method"><span id='checked_mul.v-5' class='invisible'><code>fn <a href='#method.checked_mul' class='fnname'>checked_mul</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedMul-5' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num/trait.CheckedMul.html" title="trait num::CheckedMul">CheckedMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code><a href='#impl-CheckedMul-5' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_mul-5' class="method"><span id='checked_mul.v-6' class='invisible'><code>fn <a href='#method.checked_mul' class='fnname'>checked_mul</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedMul-6' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num/trait.CheckedMul.html" title="trait num::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-6' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_mul-6' class="method"><span id='checked_mul.v-7' class='invisible'><code>fn <a href='#method.checked_mul' class='fnname'>checked_mul</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedMul-7' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num/trait.CheckedMul.html" title="trait num::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-7' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_mul-7' class="method"><span id='checked_mul.v-8' class='invisible'><code>fn <a href='#method.checked_mul' class='fnname'>checked_mul</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedMul-8' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num/trait.CheckedMul.html" title="trait num::CheckedMul">CheckedMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code><a href='#impl-CheckedMul-8' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_mul-8' class="method"><span id='checked_mul.v-9' class='invisible'><code>fn <a href='#method.checked_mul' class='fnname'>checked_mul</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedMul-9' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num/trait.CheckedMul.html" title="trait num::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-9' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_mul-9' class="method"><span id='checked_mul.v-10' class='invisible'><code>fn <a href='#method.checked_mul' class='fnname'>checked_mul</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedMul-10' class='impl'><span class='in-band'><code>impl<T> <a class="trait" href="../num/trait.CheckedMul.html" title="trait num::CheckedMul">CheckedMul</a> for <a class="struct" href="../num_rational/struct.Ratio.html" title="struct num_rational::Ratio">Ratio</a><T> <span class="where fmt-newline">where<br> 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/trait.Integer.html" title="trait num::Integer">Integer</a> + <a class="trait" href="../num/trait.CheckedMul.html" title="trait num::CheckedMul">CheckedMul</a>, </span></code><a href='#impl-CheckedMul-10' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_rational/lib.rs.html#650-658' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_mul-10' class="method"><span id='checked_mul.v-11' class='invisible'><code>fn <a href='#method.checked_mul' class='fnname'>checked_mul</a>(&self, rhs: &<a class="struct" href="../num_rational/struct.Ratio.html" title="struct num_rational::Ratio">Ratio</a><T>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../num_rational/struct.Ratio.html" title="struct num_rational::Ratio">Ratio</a><T>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_rational/lib.rs.html#654-657' 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_bigint/biguint.rs.html#902-907' title='goto source code'>[src]</a></div><code>impl CheckedMul for <a class="struct" href="../num/struct.BigUint.html" title="struct num::BigUint">BigUint</a></code></li>
|
||
<li><div class='out-of-band'><a class='srclink' href='../src/num_bigint/bigint.rs.html#943-948' title='goto source code'>[src]</a></div><code>impl CheckedMul for <a class="struct" href="../num/struct.BigInt.html" title="struct num::BigInt">BigInt</a></code></li>
|
||
</ul><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>⏎</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";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |