| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/num-traits-0.2.15/src/ops/overflowing.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>overflowing.rs - source</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" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../num_traits/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../num_traits/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>core::ops::{Add, Mul, Sub}; |
| <span class="attribute">#[cfg(has_i128)] |
| </span><span class="kw">use </span>core::{i128, u128}; |
| <span class="kw">use </span>core::{i16, i32, i64, i8, isize}; |
| <span class="kw">use </span>core::{u16, u32, u64, u8, usize}; |
| |
| <span class="macro">macro_rules! </span>overflowing_impl { |
| (<span class="macro-nonterminal">$trait_name</span>:ident, <span class="macro-nonterminal">$method</span>:ident, <span class="macro-nonterminal">$t</span>:ty) => { |
| <span class="kw">impl </span><span class="macro-nonterminal">$trait_name </span><span class="kw">for </span><span class="macro-nonterminal">$t </span>{ |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span><span class="macro-nonterminal">$method</span>(<span class="kw-2">&</span><span class="self">self</span>, v: <span class="kw-2">&</span><span class="self">Self</span>) -> (<span class="self">Self</span>, bool) { |
| <<span class="macro-nonterminal">$t</span>>::<span class="macro-nonterminal">$method</span>(<span class="kw-2">*</span><span class="self">self</span>, <span class="kw-2">*</span>v) |
| } |
| } |
| }; |
| } |
| |
| <span class="doccomment">/// Performs addition with a flag for overflow. |
| </span><span class="kw">pub trait </span>OverflowingAdd: Sized + Add<<span class="self">Self</span>, Output = <span class="self">Self</span>> { |
| <span class="doccomment">/// Returns a tuple of the sum along with a boolean indicating whether an arithmetic overflow would occur. |
| /// If an overflow would have occurred then the wrapped value is returned. |
| </span><span class="kw">fn </span>overflowing_add(<span class="kw-2">&</span><span class="self">self</span>, v: <span class="kw-2">&</span><span class="self">Self</span>) -> (<span class="self">Self</span>, bool); |
| } |
| |
| <span class="macro">overflowing_impl!</span>(OverflowingAdd, overflowing_add, u8); |
| <span class="macro">overflowing_impl!</span>(OverflowingAdd, overflowing_add, u16); |
| <span class="macro">overflowing_impl!</span>(OverflowingAdd, overflowing_add, u32); |
| <span class="macro">overflowing_impl!</span>(OverflowingAdd, overflowing_add, u64); |
| <span class="macro">overflowing_impl!</span>(OverflowingAdd, overflowing_add, usize); |
| <span class="attribute">#[cfg(has_i128)] |
| </span><span class="macro">overflowing_impl!</span>(OverflowingAdd, overflowing_add, u128); |
| |
| <span class="macro">overflowing_impl!</span>(OverflowingAdd, overflowing_add, i8); |
| <span class="macro">overflowing_impl!</span>(OverflowingAdd, overflowing_add, i16); |
| <span class="macro">overflowing_impl!</span>(OverflowingAdd, overflowing_add, i32); |
| <span class="macro">overflowing_impl!</span>(OverflowingAdd, overflowing_add, i64); |
| <span class="macro">overflowing_impl!</span>(OverflowingAdd, overflowing_add, isize); |
| <span class="attribute">#[cfg(has_i128)] |
| </span><span class="macro">overflowing_impl!</span>(OverflowingAdd, overflowing_add, i128); |
| |
| <span class="doccomment">/// Performs substraction with a flag for overflow. |
| </span><span class="kw">pub trait </span>OverflowingSub: Sized + Sub<<span class="self">Self</span>, Output = <span class="self">Self</span>> { |
| <span class="doccomment">/// Returns a tuple of the difference along with a boolean indicating whether an arithmetic overflow would occur. |
| /// If an overflow would have occurred then the wrapped value is returned. |
| </span><span class="kw">fn </span>overflowing_sub(<span class="kw-2">&</span><span class="self">self</span>, v: <span class="kw-2">&</span><span class="self">Self</span>) -> (<span class="self">Self</span>, bool); |
| } |
| |
| <span class="macro">overflowing_impl!</span>(OverflowingSub, overflowing_sub, u8); |
| <span class="macro">overflowing_impl!</span>(OverflowingSub, overflowing_sub, u16); |
| <span class="macro">overflowing_impl!</span>(OverflowingSub, overflowing_sub, u32); |
| <span class="macro">overflowing_impl!</span>(OverflowingSub, overflowing_sub, u64); |
| <span class="macro">overflowing_impl!</span>(OverflowingSub, overflowing_sub, usize); |
| <span class="attribute">#[cfg(has_i128)] |
| </span><span class="macro">overflowing_impl!</span>(OverflowingSub, overflowing_sub, u128); |
| |
| <span class="macro">overflowing_impl!</span>(OverflowingSub, overflowing_sub, i8); |
| <span class="macro">overflowing_impl!</span>(OverflowingSub, overflowing_sub, i16); |
| <span class="macro">overflowing_impl!</span>(OverflowingSub, overflowing_sub, i32); |
| <span class="macro">overflowing_impl!</span>(OverflowingSub, overflowing_sub, i64); |
| <span class="macro">overflowing_impl!</span>(OverflowingSub, overflowing_sub, isize); |
| <span class="attribute">#[cfg(has_i128)] |
| </span><span class="macro">overflowing_impl!</span>(OverflowingSub, overflowing_sub, i128); |
| |
| <span class="doccomment">/// Performs multiplication with a flag for overflow. |
| </span><span class="kw">pub trait </span>OverflowingMul: Sized + Mul<<span class="self">Self</span>, Output = <span class="self">Self</span>> { |
| <span class="doccomment">/// Returns a tuple of the product along with a boolean indicating whether an arithmetic overflow would occur. |
| /// If an overflow would have occurred then the wrapped value is returned. |
| </span><span class="kw">fn </span>overflowing_mul(<span class="kw-2">&</span><span class="self">self</span>, v: <span class="kw-2">&</span><span class="self">Self</span>) -> (<span class="self">Self</span>, bool); |
| } |
| |
| <span class="macro">overflowing_impl!</span>(OverflowingMul, overflowing_mul, u8); |
| <span class="macro">overflowing_impl!</span>(OverflowingMul, overflowing_mul, u16); |
| <span class="macro">overflowing_impl!</span>(OverflowingMul, overflowing_mul, u32); |
| <span class="macro">overflowing_impl!</span>(OverflowingMul, overflowing_mul, u64); |
| <span class="macro">overflowing_impl!</span>(OverflowingMul, overflowing_mul, usize); |
| <span class="attribute">#[cfg(has_i128)] |
| </span><span class="macro">overflowing_impl!</span>(OverflowingMul, overflowing_mul, u128); |
| |
| <span class="macro">overflowing_impl!</span>(OverflowingMul, overflowing_mul, i8); |
| <span class="macro">overflowing_impl!</span>(OverflowingMul, overflowing_mul, i16); |
| <span class="macro">overflowing_impl!</span>(OverflowingMul, overflowing_mul, i32); |
| <span class="macro">overflowing_impl!</span>(OverflowingMul, overflowing_mul, i64); |
| <span class="macro">overflowing_impl!</span>(OverflowingMul, overflowing_mul, isize); |
| <span class="attribute">#[cfg(has_i128)] |
| </span><span class="macro">overflowing_impl!</span>(OverflowingMul, overflowing_mul, i128); |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_overflowing_traits() { |
| <span class="kw">fn </span>overflowing_add<T: OverflowingAdd>(a: T, b: T) -> (T, bool) { |
| a.overflowing_add(<span class="kw-2">&</span>b) |
| } |
| <span class="kw">fn </span>overflowing_sub<T: OverflowingSub>(a: T, b: T) -> (T, bool) { |
| a.overflowing_sub(<span class="kw-2">&</span>b) |
| } |
| <span class="kw">fn </span>overflowing_mul<T: OverflowingMul>(a: T, b: T) -> (T, bool) { |
| a.overflowing_mul(<span class="kw-2">&</span>b) |
| } |
| <span class="macro">assert_eq!</span>(overflowing_add(<span class="number">5i16</span>, <span class="number">2</span>), (<span class="number">7</span>, <span class="bool-val">false</span>)); |
| <span class="macro">assert_eq!</span>(overflowing_add(i16::MAX, <span class="number">1</span>), (i16::MIN, <span class="bool-val">true</span>)); |
| <span class="macro">assert_eq!</span>(overflowing_sub(<span class="number">5i16</span>, <span class="number">2</span>), (<span class="number">3</span>, <span class="bool-val">false</span>)); |
| <span class="macro">assert_eq!</span>(overflowing_sub(i16::MIN, <span class="number">1</span>), (i16::MAX, <span class="bool-val">true</span>)); |
| <span class="macro">assert_eq!</span>(overflowing_mul(<span class="number">5i16</span>, <span class="number">2</span>), (<span class="number">10</span>, <span class="bool-val">false</span>)); |
| <span class="macro">assert_eq!</span>(overflowing_mul(<span class="number">1_000_000_000i32</span>, <span class="number">10</span>), (<span class="number">1410065408</span>, <span class="bool-val">true</span>)); |
| } |
| </code></pre></div> |
| </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.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
