blob: 4f69f8d5a2d67c36327677bbb1df9818d39576f1 [file] [log] [blame]
<!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="Performs multiplication that wraps around on overflow."><meta name="keywords" content="rust, rustlang, rust-lang, WrappingMul"><title>WrappingMul in num_traits::ops::wrapping - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><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="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script src="../../../crates.js"></script><script defer src="../../../main.js"></script>
<noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a class="sidebar-logo" href="../../../num_traits/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.png" alt="logo"></div>
</a><h2 class="location">Trait WrappingMul</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.wrapping_mul">wrapping_mul</a></div><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><div class="sidebar-links"><a href="#impl-WrappingMul-for-Wrapping%3CT%3E">Wrapping&lt;T&gt;</a><a href="#impl-WrappingMul-for-i128">i128</a><a href="#impl-WrappingMul-for-i16">i16</a><a href="#impl-WrappingMul-for-i32">i32</a><a href="#impl-WrappingMul-for-i64">i64</a><a href="#impl-WrappingMul-for-i8">i8</a><a href="#impl-WrappingMul-for-isize">isize</a><a href="#impl-WrappingMul-for-u128">u128</a><a href="#impl-WrappingMul-for-u16">u16</a><a href="#impl-WrappingMul-for-u32">u32</a><a href="#impl-WrappingMul-for-u64">u64</a><a href="#impl-WrappingMul-for-u8">u8</a><a href="#impl-WrappingMul-for-usize">usize</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="../../index.html">num_traits</a>::<wbr><a href="../index.html">ops</a>::<wbr><a href="index.html">wrapping</a></h2><div id="sidebar-vars" data-name="WrappingMul" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../num_traits/index.html"><img class="rust-logo" src="../../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div>
<input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Trait <a href="../../index.html">num_traits</a>::<wbr><a href="../index.html">ops</a>::<wbr><a href="index.html">wrapping</a>::<wbr><a class="trait" href="#">WrappingMul</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band">
<a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#70-74" title="goto source code">source</a> ·
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div>
<div class="docblock item-decl"><pre class="rust trait"><code>pub trait WrappingMul: <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="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.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Performs multiplication that wraps around on overflow.</p>
</div></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.wrapping_mul" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#73" title="goto source code">source</a></div><h4 class="code-header">fn <a href="#tymethod.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></div></summary><div class="docblock"><p>Wrapping (modular) multiplication. Computes <code>self * other</code>, wrapping around at the boundary
of the type.</p>
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-WrappingMul-for-u8" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#76" title="goto source code">source</a></div><a href="#impl-WrappingMul-for-u8" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></h3></div></summary><div class="impl-items"><div id="method.wrapping_mul" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#76" title="goto source code">source</a></div><a href="#method.wrapping_mul" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-WrappingMul-for-u16" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#77" title="goto source code">source</a></div><a href="#impl-WrappingMul-for-u16" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></h3></div></summary><div class="impl-items"><div id="method.wrapping_mul-1" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#77" title="goto source code">source</a></div><a href="#method.wrapping_mul-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-WrappingMul-for-u32" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#78" title="goto source code">source</a></div><a href="#impl-WrappingMul-for-u32" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></h3></div></summary><div class="impl-items"><div id="method.wrapping_mul-2" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#78" title="goto source code">source</a></div><a href="#method.wrapping_mul-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-WrappingMul-for-u64" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#79" title="goto source code">source</a></div><a href="#impl-WrappingMul-for-u64" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></h3></div></summary><div class="impl-items"><div id="method.wrapping_mul-3" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#79" title="goto source code">source</a></div><a href="#method.wrapping_mul-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-WrappingMul-for-usize" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#80" title="goto source code">source</a></div><a href="#impl-WrappingMul-for-usize" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h3></div></summary><div class="impl-items"><div id="method.wrapping_mul-4" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#80" title="goto source code">source</a></div><a href="#method.wrapping_mul-4" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-WrappingMul-for-u128" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#82" title="goto source code">source</a></div><a href="#impl-WrappingMul-for-u128" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u128.html">u128</a></h3></div></summary><div class="impl-items"><div id="method.wrapping_mul-5" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#82" title="goto source code">source</a></div><a href="#method.wrapping_mul-5" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-WrappingMul-for-i8" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#84" title="goto source code">source</a></div><a href="#impl-WrappingMul-for-i8" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></h3></div></summary><div class="impl-items"><div id="method.wrapping_mul-6" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#84" title="goto source code">source</a></div><a href="#method.wrapping_mul-6" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-WrappingMul-for-i16" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#85" title="goto source code">source</a></div><a href="#impl-WrappingMul-for-i16" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></h3></div></summary><div class="impl-items"><div id="method.wrapping_mul-7" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#85" title="goto source code">source</a></div><a href="#method.wrapping_mul-7" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-WrappingMul-for-i32" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#86" title="goto source code">source</a></div><a href="#impl-WrappingMul-for-i32" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></h3></div></summary><div class="impl-items"><div id="method.wrapping_mul-8" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#86" title="goto source code">source</a></div><a href="#method.wrapping_mul-8" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-WrappingMul-for-i64" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#87" title="goto source code">source</a></div><a href="#impl-WrappingMul-for-i64" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></h3></div></summary><div class="impl-items"><div id="method.wrapping_mul-9" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#87" title="goto source code">source</a></div><a href="#method.wrapping_mul-9" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-WrappingMul-for-isize" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#88" title="goto source code">source</a></div><a href="#impl-WrappingMul-for-isize" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></h3></div></summary><div class="impl-items"><div id="method.wrapping_mul-10" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#88" title="goto source code">source</a></div><a href="#method.wrapping_mul-10" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-WrappingMul-for-i128" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#90" title="goto source code">source</a></div><a href="#impl-WrappingMul-for-i128" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i128.html">i128</a></h3></div></summary><div class="impl-items"><div id="method.wrapping_mul-11" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#90" title="goto source code">source</a></div><a href="#method.wrapping_mul-11" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-WrappingMul-for-Wrapping%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#238-245" title="goto source code">source</a></div><a href="#impl-WrappingMul-for-Wrapping%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl&lt;T:&nbsp;<a class="trait" href="trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a>&gt; <a class="trait" href="trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</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>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a>&lt;T&gt;: <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;Output = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a>&lt;T&gt;&gt;,&nbsp;</span></h3></div></summary><div class="impl-items"><div id="method.wrapping_mul-12" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#242-244" title="goto source code">source</a></div><a href="#method.wrapping_mul-12" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.wrapping_mul" class="fnname">wrapping_mul</a>(&amp;self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></div></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../../../implementors/num_traits/ops/wrapping/trait.WrappingMul.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="num_traits" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.60.0-nightly (1bd4fdc94 2022-01-12)" ></div>
</body></html>