<!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 to the Rust file `/home/frans/.cargo/registry/src/github.com-1ecc6299db9ec823/num-traits-0.1.32/src/ops/saturating.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>saturating.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../main.css">
</head>
<body class="rustdoc">
<nav class="sidebar">
</nav>
<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 source"><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>
</pre><pre class='rust '>
<span class='doccomment'>/// Saturating math operations</span>
<span class='kw'>pub</span> <span class='kw'>trait</span> <span class='ident'>Saturating</span> {
<span class='doccomment'>/// Saturating addition operator.</span>
<span class='doccomment'>/// Returns a+b, saturating at the numeric bounds instead of overflowing.</span>
<span class='kw'>fn</span> <span class='ident'>saturating_add</span>(<span class='self'>self</span>, <span class='ident'>v</span>: <span class='self'>Self</span>) <span class='op'>-></span> <span class='self'>Self</span>;
<span class='doccomment'>/// Saturating subtraction operator.</span>
<span class='doccomment'>/// Returns a-b, saturating at the numeric bounds instead of overflowing.</span>
<span class='kw'>fn</span> <span class='ident'>saturating_sub</span>(<span class='self'>self</span>, <span class='ident'>v</span>: <span class='self'>Self</span>) <span class='op'>-></span> <span class='self'>Self</span>;
}
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>saturating_impl</span> {
(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>trait_name</span>:<span class='ident'>ident</span> <span class='kw'>for</span> $(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span>:<span class='ident'>ty</span>)<span class='op'>*</span>) <span class='op'>=></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='kw'>fn</span> <span class='ident'>saturating_add</span>(<span class='self'>self</span>, <span class='ident'>v</span>: <span class='self'>Self</span>) <span class='op'>-></span> <span class='self'>Self</span> {
<span class='self'>Self</span>::<span class='ident'>saturating_add</span>(<span class='self'>self</span>, <span class='ident'>v</span>)
}
<span class='kw'>fn</span> <span class='ident'>saturating_sub</span>(<span class='self'>self</span>, <span class='ident'>v</span>: <span class='self'>Self</span>) <span class='op'>-></span> <span class='self'>Self</span> {
<span class='self'>Self</span>::<span class='ident'>saturating_sub</span>(<span class='self'>self</span>, <span class='ident'>v</span>)
}
}
)<span class='op'>*</span>}
}
<span class='macro'>saturating_impl</span><span class='macro'>!</span>(<span class='ident'>Saturating</span> <span class='kw'>for</span> <span class='ident'>isize</span> <span class='ident'>usize</span> <span class='ident'>i8</span> <span class='ident'>u8</span> <span class='ident'>i16</span> <span class='ident'>u16</span> <span class='ident'>i32</span> <span class='ident'>u32</span> <span class='ident'>i64</span> <span class='ident'>u64</span>);
</pre>
</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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_traits";
window.playgroundUrl = "";
</script>
<script src="../../../jquery.js"></script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>