| <!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 `/home/runner/.cargo/registry/src/github.com-1ecc6299db9ec823/num-traits-0.2.14/src/ops/checked.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>checked.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" 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><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.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"><div class="sidebar-menu" role="button">☰</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></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="example-wrap"><pre class="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> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| </pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">core::ops</span>::{<span class="ident">Add</span>, <span class="ident">Div</span>, <span class="ident">Mul</span>, <span class="ident">Rem</span>, <span class="ident">Shl</span>, <span class="ident">Shr</span>, <span class="ident">Sub</span>}; |
| |
| <span class="doccomment">/// Performs addition that returns `None` instead of wrapping around on</span> |
| <span class="doccomment">/// overflow.</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">CheckedAdd</span>: <span class="ident">Sized</span> <span class="op">+</span> <span class="ident">Add</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">Output</span> <span class="op">=</span> <span class="self">Self</span><span class="op">></span> { |
| <span class="doccomment">/// Adds two numbers, checking for overflow. If overflow happens, `None` is</span> |
| <span class="doccomment">/// returned.</span> |
| <span class="kw">fn</span> <span class="ident">checked_add</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">v</span>: <span class="kw-2">&</span><span class="self">Self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>; |
| } |
| |
| <span class="macro">macro_rules!</span> <span class="ident">checked_impl</span> { |
| (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">method</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>:<span class="ident">ty</span>) => { |
| <span class="kw">impl</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_name</span> <span class="kw">for</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span> { |
| <span class="attribute">#[<span class="ident">inline</span>]</span> |
| <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">method</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">v</span>: <span class="kw-2">&</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span><span class="op">></span> { |
| <span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span><span class="op">></span>::<span class="macro-nonterminal">$</span><span class="macro-nonterminal">method</span>(<span class="kw-2">*</span><span class="self">self</span>, <span class="kw-2">*</span><span class="ident">v</span>) |
| } |
| } |
| }; |
| } |
| |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedAdd</span>, <span class="ident">checked_add</span>, <span class="ident">u8</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedAdd</span>, <span class="ident">checked_add</span>, <span class="ident">u16</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedAdd</span>, <span class="ident">checked_add</span>, <span class="ident">u32</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedAdd</span>, <span class="ident">checked_add</span>, <span class="ident">u64</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedAdd</span>, <span class="ident">checked_add</span>, <span class="ident">usize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedAdd</span>, <span class="ident">checked_add</span>, <span class="ident">u128</span>); |
| |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedAdd</span>, <span class="ident">checked_add</span>, <span class="ident">i8</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedAdd</span>, <span class="ident">checked_add</span>, <span class="ident">i16</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedAdd</span>, <span class="ident">checked_add</span>, <span class="ident">i32</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedAdd</span>, <span class="ident">checked_add</span>, <span class="ident">i64</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedAdd</span>, <span class="ident">checked_add</span>, <span class="ident">isize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedAdd</span>, <span class="ident">checked_add</span>, <span class="ident">i128</span>); |
| |
| <span class="doccomment">/// Performs subtraction that returns `None` instead of wrapping around on underflow.</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">CheckedSub</span>: <span class="ident">Sized</span> <span class="op">+</span> <span class="ident">Sub</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">Output</span> <span class="op">=</span> <span class="self">Self</span><span class="op">></span> { |
| <span class="doccomment">/// Subtracts two numbers, checking for underflow. If underflow happens,</span> |
| <span class="doccomment">/// `None` is returned.</span> |
| <span class="kw">fn</span> <span class="ident">checked_sub</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">v</span>: <span class="kw-2">&</span><span class="self">Self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>; |
| } |
| |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedSub</span>, <span class="ident">checked_sub</span>, <span class="ident">u8</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedSub</span>, <span class="ident">checked_sub</span>, <span class="ident">u16</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedSub</span>, <span class="ident">checked_sub</span>, <span class="ident">u32</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedSub</span>, <span class="ident">checked_sub</span>, <span class="ident">u64</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedSub</span>, <span class="ident">checked_sub</span>, <span class="ident">usize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedSub</span>, <span class="ident">checked_sub</span>, <span class="ident">u128</span>); |
| |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedSub</span>, <span class="ident">checked_sub</span>, <span class="ident">i8</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedSub</span>, <span class="ident">checked_sub</span>, <span class="ident">i16</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedSub</span>, <span class="ident">checked_sub</span>, <span class="ident">i32</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedSub</span>, <span class="ident">checked_sub</span>, <span class="ident">i64</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedSub</span>, <span class="ident">checked_sub</span>, <span class="ident">isize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedSub</span>, <span class="ident">checked_sub</span>, <span class="ident">i128</span>); |
| |
| <span class="doccomment">/// Performs multiplication that returns `None` instead of wrapping around on underflow or</span> |
| <span class="doccomment">/// overflow.</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">CheckedMul</span>: <span class="ident">Sized</span> <span class="op">+</span> <span class="ident">Mul</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">Output</span> <span class="op">=</span> <span class="self">Self</span><span class="op">></span> { |
| <span class="doccomment">/// Multiplies two numbers, checking for underflow or overflow. If underflow</span> |
| <span class="doccomment">/// or overflow happens, `None` is returned.</span> |
| <span class="kw">fn</span> <span class="ident">checked_mul</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">v</span>: <span class="kw-2">&</span><span class="self">Self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>; |
| } |
| |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedMul</span>, <span class="ident">checked_mul</span>, <span class="ident">u8</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedMul</span>, <span class="ident">checked_mul</span>, <span class="ident">u16</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedMul</span>, <span class="ident">checked_mul</span>, <span class="ident">u32</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedMul</span>, <span class="ident">checked_mul</span>, <span class="ident">u64</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedMul</span>, <span class="ident">checked_mul</span>, <span class="ident">usize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedMul</span>, <span class="ident">checked_mul</span>, <span class="ident">u128</span>); |
| |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedMul</span>, <span class="ident">checked_mul</span>, <span class="ident">i8</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedMul</span>, <span class="ident">checked_mul</span>, <span class="ident">i16</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedMul</span>, <span class="ident">checked_mul</span>, <span class="ident">i32</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedMul</span>, <span class="ident">checked_mul</span>, <span class="ident">i64</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedMul</span>, <span class="ident">checked_mul</span>, <span class="ident">isize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedMul</span>, <span class="ident">checked_mul</span>, <span class="ident">i128</span>); |
| |
| <span class="doccomment">/// Performs division that returns `None` instead of panicking on division by zero and instead of</span> |
| <span class="doccomment">/// wrapping around on underflow and overflow.</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">CheckedDiv</span>: <span class="ident">Sized</span> <span class="op">+</span> <span class="ident">Div</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">Output</span> <span class="op">=</span> <span class="self">Self</span><span class="op">></span> { |
| <span class="doccomment">/// Divides two numbers, checking for underflow, overflow and division by</span> |
| <span class="doccomment">/// zero. If any of that happens, `None` is returned.</span> |
| <span class="kw">fn</span> <span class="ident">checked_div</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">v</span>: <span class="kw-2">&</span><span class="self">Self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>; |
| } |
| |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedDiv</span>, <span class="ident">checked_div</span>, <span class="ident">u8</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedDiv</span>, <span class="ident">checked_div</span>, <span class="ident">u16</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedDiv</span>, <span class="ident">checked_div</span>, <span class="ident">u32</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedDiv</span>, <span class="ident">checked_div</span>, <span class="ident">u64</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedDiv</span>, <span class="ident">checked_div</span>, <span class="ident">usize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedDiv</span>, <span class="ident">checked_div</span>, <span class="ident">u128</span>); |
| |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedDiv</span>, <span class="ident">checked_div</span>, <span class="ident">i8</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedDiv</span>, <span class="ident">checked_div</span>, <span class="ident">i16</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedDiv</span>, <span class="ident">checked_div</span>, <span class="ident">i32</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedDiv</span>, <span class="ident">checked_div</span>, <span class="ident">i64</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedDiv</span>, <span class="ident">checked_div</span>, <span class="ident">isize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedDiv</span>, <span class="ident">checked_div</span>, <span class="ident">i128</span>); |
| |
| <span class="doccomment">/// Performs an integral remainder that returns `None` instead of panicking on division by zero and</span> |
| <span class="doccomment">/// instead of wrapping around on underflow and overflow.</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">CheckedRem</span>: <span class="ident">Sized</span> <span class="op">+</span> <span class="ident">Rem</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">Output</span> <span class="op">=</span> <span class="self">Self</span><span class="op">></span> { |
| <span class="doccomment">/// Finds the remainder of dividing two numbers, checking for underflow, overflow and division</span> |
| <span class="doccomment">/// by zero. If any of that happens, `None` is returned.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Examples</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// ```</span> |
| <span class="doccomment">/// use num_traits::CheckedRem;</span> |
| <span class="doccomment">/// use std::i32::MIN;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// assert_eq!(CheckedRem::checked_rem(&10, &7), Some(3));</span> |
| <span class="doccomment">/// assert_eq!(CheckedRem::checked_rem(&10, &-7), Some(3));</span> |
| <span class="doccomment">/// assert_eq!(CheckedRem::checked_rem(&-10, &7), Some(-3));</span> |
| <span class="doccomment">/// assert_eq!(CheckedRem::checked_rem(&-10, &-7), Some(-3));</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// assert_eq!(CheckedRem::checked_rem(&10, &0), None);</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// assert_eq!(CheckedRem::checked_rem(&MIN, &1), Some(0));</span> |
| <span class="doccomment">/// assert_eq!(CheckedRem::checked_rem(&MIN, &-1), None);</span> |
| <span class="doccomment">/// ```</span> |
| <span class="kw">fn</span> <span class="ident">checked_rem</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">v</span>: <span class="kw-2">&</span><span class="self">Self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>; |
| } |
| |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedRem</span>, <span class="ident">checked_rem</span>, <span class="ident">u8</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedRem</span>, <span class="ident">checked_rem</span>, <span class="ident">u16</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedRem</span>, <span class="ident">checked_rem</span>, <span class="ident">u32</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedRem</span>, <span class="ident">checked_rem</span>, <span class="ident">u64</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedRem</span>, <span class="ident">checked_rem</span>, <span class="ident">usize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedRem</span>, <span class="ident">checked_rem</span>, <span class="ident">u128</span>); |
| |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedRem</span>, <span class="ident">checked_rem</span>, <span class="ident">i8</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedRem</span>, <span class="ident">checked_rem</span>, <span class="ident">i16</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedRem</span>, <span class="ident">checked_rem</span>, <span class="ident">i32</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedRem</span>, <span class="ident">checked_rem</span>, <span class="ident">i64</span>); |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedRem</span>, <span class="ident">checked_rem</span>, <span class="ident">isize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_impl!</span>(<span class="ident">CheckedRem</span>, <span class="ident">checked_rem</span>, <span class="ident">i128</span>); |
| |
| <span class="macro">macro_rules!</span> <span class="ident">checked_impl_unary</span> { |
| (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">method</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>:<span class="ident">ty</span>) => { |
| <span class="kw">impl</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_name</span> <span class="kw">for</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span> { |
| <span class="attribute">#[<span class="ident">inline</span>]</span> |
| <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">method</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span><span class="op">></span> { |
| <span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span><span class="op">></span>::<span class="macro-nonterminal">$</span><span class="macro-nonterminal">method</span>(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| } |
| }; |
| } |
| |
| <span class="doccomment">/// Performs negation that returns `None` if the result can't be represented.</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">CheckedNeg</span>: <span class="ident">Sized</span> { |
| <span class="doccomment">/// Negates a number, returning `None` for results that can't be represented, like signed `MIN`</span> |
| <span class="doccomment">/// values that can't be positive, or non-zero unsigned values that can't be negative.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Examples</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// ```</span> |
| <span class="doccomment">/// use num_traits::CheckedNeg;</span> |
| <span class="doccomment">/// use std::i32::MIN;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// assert_eq!(CheckedNeg::checked_neg(&1_i32), Some(-1));</span> |
| <span class="doccomment">/// assert_eq!(CheckedNeg::checked_neg(&-1_i32), Some(1));</span> |
| <span class="doccomment">/// assert_eq!(CheckedNeg::checked_neg(&MIN), None);</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// assert_eq!(CheckedNeg::checked_neg(&0_u32), Some(0));</span> |
| <span class="doccomment">/// assert_eq!(CheckedNeg::checked_neg(&1_u32), None);</span> |
| <span class="doccomment">/// ```</span> |
| <span class="kw">fn</span> <span class="ident">checked_neg</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>; |
| } |
| |
| <span class="macro">checked_impl_unary!</span>(<span class="ident">CheckedNeg</span>, <span class="ident">checked_neg</span>, <span class="ident">u8</span>); |
| <span class="macro">checked_impl_unary!</span>(<span class="ident">CheckedNeg</span>, <span class="ident">checked_neg</span>, <span class="ident">u16</span>); |
| <span class="macro">checked_impl_unary!</span>(<span class="ident">CheckedNeg</span>, <span class="ident">checked_neg</span>, <span class="ident">u32</span>); |
| <span class="macro">checked_impl_unary!</span>(<span class="ident">CheckedNeg</span>, <span class="ident">checked_neg</span>, <span class="ident">u64</span>); |
| <span class="macro">checked_impl_unary!</span>(<span class="ident">CheckedNeg</span>, <span class="ident">checked_neg</span>, <span class="ident">usize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_impl_unary!</span>(<span class="ident">CheckedNeg</span>, <span class="ident">checked_neg</span>, <span class="ident">u128</span>); |
| |
| <span class="macro">checked_impl_unary!</span>(<span class="ident">CheckedNeg</span>, <span class="ident">checked_neg</span>, <span class="ident">i8</span>); |
| <span class="macro">checked_impl_unary!</span>(<span class="ident">CheckedNeg</span>, <span class="ident">checked_neg</span>, <span class="ident">i16</span>); |
| <span class="macro">checked_impl_unary!</span>(<span class="ident">CheckedNeg</span>, <span class="ident">checked_neg</span>, <span class="ident">i32</span>); |
| <span class="macro">checked_impl_unary!</span>(<span class="ident">CheckedNeg</span>, <span class="ident">checked_neg</span>, <span class="ident">i64</span>); |
| <span class="macro">checked_impl_unary!</span>(<span class="ident">CheckedNeg</span>, <span class="ident">checked_neg</span>, <span class="ident">isize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_impl_unary!</span>(<span class="ident">CheckedNeg</span>, <span class="ident">checked_neg</span>, <span class="ident">i128</span>); |
| |
| <span class="doccomment">/// Performs a left shift that returns `None` on shifts larger than</span> |
| <span class="doccomment">/// the type width.</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">CheckedShl</span>: <span class="ident">Sized</span> <span class="op">+</span> <span class="ident">Shl</span><span class="op"><</span><span class="ident">u32</span>, <span class="ident">Output</span> <span class="op">=</span> <span class="self">Self</span><span class="op">></span> { |
| <span class="doccomment">/// Checked shift left. Computes `self << rhs`, returning `None`</span> |
| <span class="doccomment">/// if `rhs` is larger than or equal to the number of bits in `self`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// ```</span> |
| <span class="doccomment">/// use num_traits::CheckedShl;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// let x: u16 = 0x0001;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// assert_eq!(CheckedShl::checked_shl(&x, 0), Some(0x0001));</span> |
| <span class="doccomment">/// assert_eq!(CheckedShl::checked_shl(&x, 1), Some(0x0002));</span> |
| <span class="doccomment">/// assert_eq!(CheckedShl::checked_shl(&x, 15), Some(0x8000));</span> |
| <span class="doccomment">/// assert_eq!(CheckedShl::checked_shl(&x, 16), None);</span> |
| <span class="doccomment">/// ```</span> |
| <span class="kw">fn</span> <span class="ident">checked_shl</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">rhs</span>: <span class="ident">u32</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>; |
| } |
| |
| <span class="macro">macro_rules!</span> <span class="ident">checked_shift_impl</span> { |
| (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">method</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>:<span class="ident">ty</span>) => { |
| <span class="kw">impl</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">trait_name</span> <span class="kw">for</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span> { |
| <span class="attribute">#[<span class="ident">inline</span>]</span> |
| <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">method</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">rhs</span>: <span class="ident">u32</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span><span class="op">></span> { |
| <span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span><span class="op">></span>::<span class="macro-nonterminal">$</span><span class="macro-nonterminal">method</span>(<span class="kw-2">*</span><span class="self">self</span>, <span class="ident">rhs</span>) |
| } |
| } |
| }; |
| } |
| |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShl</span>, <span class="ident">checked_shl</span>, <span class="ident">u8</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShl</span>, <span class="ident">checked_shl</span>, <span class="ident">u16</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShl</span>, <span class="ident">checked_shl</span>, <span class="ident">u32</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShl</span>, <span class="ident">checked_shl</span>, <span class="ident">u64</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShl</span>, <span class="ident">checked_shl</span>, <span class="ident">usize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShl</span>, <span class="ident">checked_shl</span>, <span class="ident">u128</span>); |
| |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShl</span>, <span class="ident">checked_shl</span>, <span class="ident">i8</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShl</span>, <span class="ident">checked_shl</span>, <span class="ident">i16</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShl</span>, <span class="ident">checked_shl</span>, <span class="ident">i32</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShl</span>, <span class="ident">checked_shl</span>, <span class="ident">i64</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShl</span>, <span class="ident">checked_shl</span>, <span class="ident">isize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShl</span>, <span class="ident">checked_shl</span>, <span class="ident">i128</span>); |
| |
| <span class="doccomment">/// Performs a right shift that returns `None` on shifts larger than</span> |
| <span class="doccomment">/// the type width.</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">CheckedShr</span>: <span class="ident">Sized</span> <span class="op">+</span> <span class="ident">Shr</span><span class="op"><</span><span class="ident">u32</span>, <span class="ident">Output</span> <span class="op">=</span> <span class="self">Self</span><span class="op">></span> { |
| <span class="doccomment">/// Checked shift right. Computes `self >> rhs`, returning `None`</span> |
| <span class="doccomment">/// if `rhs` is larger than or equal to the number of bits in `self`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// ```</span> |
| <span class="doccomment">/// use num_traits::CheckedShr;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// let x: u16 = 0x8000;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// assert_eq!(CheckedShr::checked_shr(&x, 0), Some(0x8000));</span> |
| <span class="doccomment">/// assert_eq!(CheckedShr::checked_shr(&x, 1), Some(0x4000));</span> |
| <span class="doccomment">/// assert_eq!(CheckedShr::checked_shr(&x, 15), Some(0x0001));</span> |
| <span class="doccomment">/// assert_eq!(CheckedShr::checked_shr(&x, 16), None);</span> |
| <span class="doccomment">/// ```</span> |
| <span class="kw">fn</span> <span class="ident">checked_shr</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">rhs</span>: <span class="ident">u32</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>; |
| } |
| |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShr</span>, <span class="ident">checked_shr</span>, <span class="ident">u8</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShr</span>, <span class="ident">checked_shr</span>, <span class="ident">u16</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShr</span>, <span class="ident">checked_shr</span>, <span class="ident">u32</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShr</span>, <span class="ident">checked_shr</span>, <span class="ident">u64</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShr</span>, <span class="ident">checked_shr</span>, <span class="ident">usize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShr</span>, <span class="ident">checked_shr</span>, <span class="ident">u128</span>); |
| |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShr</span>, <span class="ident">checked_shr</span>, <span class="ident">i8</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShr</span>, <span class="ident">checked_shr</span>, <span class="ident">i16</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShr</span>, <span class="ident">checked_shr</span>, <span class="ident">i32</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShr</span>, <span class="ident">checked_shr</span>, <span class="ident">i64</span>); |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShr</span>, <span class="ident">checked_shr</span>, <span class="ident">isize</span>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">checked_shift_impl!</span>(<span class="ident">CheckedShr</span>, <span class="ident">checked_shr</span>, <span class="ident">i128</span>); |
| </code></pre></div> |
| </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> |
