<!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 `Saturating` trait in crate `num_traits`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Saturating">
<title>num_traits::Saturating - 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 Saturating</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.saturating_add">saturating_add</a><a href="#tymethod.saturating_sub">saturating_sub</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Saturating">i32</a><a href="#impl-Saturating">isize</a><a href="#impl-Saturating">u8</a><a href="#impl-Saturating">i16</a><a href="#impl-Saturating">u16</a><a href="#impl-Saturating">i8</a><a href="#impl-Saturating">usize</a><a href="#impl-Saturating">u64</a><a href="#impl-Saturating">i64</a><a href="#impl-Saturating">u32</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>num_traits</a></p><script>window.sidebarCurrent = {name: 'Saturating', 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_traits</a>::<wbr><a class="trait" href=''>Saturating</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/saturating.rs.html#2-10' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait Saturating {
fn <a href='#tymethod.saturating_add' class='fnname'>saturating_add</a>(self, v: Self) -> Self;
<div class='item-spacer'></div> fn <a href='#tymethod.saturating_sub' class='fnname'>saturating_sub</a>(self, v: Self) -> Self;
}</pre><div class='docblock'><p>Saturating math operations</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.saturating_add' class='method'><span id='saturating_add.v' class='invisible'><code>fn <a href='#tymethod.saturating_add' class='fnname'>saturating_add</a>(self, v: Self) -> Self</code></span></h3><div class='docblock'><p>Saturating addition operator.
Returns a+b, saturating at the numeric bounds instead of overflowing.</p>
</div><h3 id='tymethod.saturating_sub' class='method'><span id='saturating_sub.v' class='invisible'><code>fn <a href='#tymethod.saturating_sub' class='fnname'>saturating_sub</a>(self, v: Self) -> Self</code></span></h3><div class='docblock'><p>Saturating subtraction operator.
Returns a-b, saturating at the numeric bounds instead of overflowing.</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-Saturating' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num_traits/ops/saturating/trait.Saturating.html" title="trait num_traits::ops::saturating::Saturating">Saturating</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code><a href='#impl-Saturating' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/saturating.rs.html#14-24' title='goto source code'>[src]</a></span></h3>
<span class='docblock autohide'><div class='impl-items'><h4 id='method.saturating_add' class="method"><span id='saturating_add.v-1' class='invisible'><code>fn <a href='#method.saturating_add' class='fnname'>saturating_add</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</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/saturating.rs.html#16-18' title='goto source code'>[src]</a></span></h4>
<h4 id='method.saturating_sub' class="method"><span id='saturating_sub.v-1' class='invisible'><code>fn <a href='#method.saturating_sub' class='fnname'>saturating_sub</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</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/saturating.rs.html#21-23' title='goto source code'>[src]</a></span></h4>
</div></span><h3 id='impl-Saturating-1' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num_traits/ops/saturating/trait.Saturating.html" title="trait num_traits::ops::saturating::Saturating">Saturating</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></code><a href='#impl-Saturating-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/saturating.rs.html#14-24' title='goto source code'>[src]</a></span></h3>
<span class='docblock autohide'><div class='impl-items'><h4 id='method.saturating_add-1' class="method"><span id='saturating_add.v-2' class='invisible'><code>fn <a href='#method.saturating_add' class='fnname'>saturating_add</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</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/saturating.rs.html#16-18' title='goto source code'>[src]</a></span></h4>
<h4 id='method.saturating_sub-1' class="method"><span id='saturating_sub.v-2' class='invisible'><code>fn <a href='#method.saturating_sub' class='fnname'>saturating_sub</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</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/saturating.rs.html#21-23' title='goto source code'>[src]</a></span></h4>
</div></span><h3 id='impl-Saturating-2' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num_traits/ops/saturating/trait.Saturating.html" title="trait num_traits::ops::saturating::Saturating">Saturating</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a href='#impl-Saturating-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/saturating.rs.html#14-24' title='goto source code'>[src]</a></span></h3>
<span class='docblock autohide'><div class='impl-items'><h4 id='method.saturating_add-2' class="method"><span id='saturating_add.v-3' class='invisible'><code>fn <a href='#method.saturating_add' class='fnname'>saturating_add</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</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/saturating.rs.html#16-18' title='goto source code'>[src]</a></span></h4>
<h4 id='method.saturating_sub-2' class="method"><span id='saturating_sub.v-3' class='invisible'><code>fn <a href='#method.saturating_sub' class='fnname'>saturating_sub</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</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/saturating.rs.html#21-23' title='goto source code'>[src]</a></span></h4>
</div></span><h3 id='impl-Saturating-3' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num_traits/ops/saturating/trait.Saturating.html" title="trait num_traits::ops::saturating::Saturating">Saturating</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></code><a href='#impl-Saturating-3' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/saturating.rs.html#14-24' title='goto source code'>[src]</a></span></h3>
<span class='docblock autohide'><div class='impl-items'><h4 id='method.saturating_add-3' class="method"><span id='saturating_add.v-4' class='invisible'><code>fn <a href='#method.saturating_add' class='fnname'>saturating_add</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</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/saturating.rs.html#16-18' title='goto source code'>[src]</a></span></h4>
<h4 id='method.saturating_sub-3' class="method"><span id='saturating_sub.v-4' class='invisible'><code>fn <a href='#method.saturating_sub' class='fnname'>saturating_sub</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</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/saturating.rs.html#21-23' title='goto source code'>[src]</a></span></h4>
</div></span><h3 id='impl-Saturating-4' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num_traits/ops/saturating/trait.Saturating.html" title="trait num_traits::ops::saturating::Saturating">Saturating</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code><a href='#impl-Saturating-4' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/saturating.rs.html#14-24' title='goto source code'>[src]</a></span></h3>
<span class='docblock autohide'><div class='impl-items'><h4 id='method.saturating_add-4' class="method"><span id='saturating_add.v-5' class='invisible'><code>fn <a href='#method.saturating_add' class='fnname'>saturating_add</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</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/saturating.rs.html#16-18' title='goto source code'>[src]</a></span></h4>
<h4 id='method.saturating_sub-4' class="method"><span id='saturating_sub.v-5' class='invisible'><code>fn <a href='#method.saturating_sub' class='fnname'>saturating_sub</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</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/saturating.rs.html#21-23' title='goto source code'>[src]</a></span></h4>
</div></span><h3 id='impl-Saturating-5' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num_traits/ops/saturating/trait.Saturating.html" title="trait num_traits::ops::saturating::Saturating">Saturating</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code><a href='#impl-Saturating-5' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/saturating.rs.html#14-24' title='goto source code'>[src]</a></span></h3>
<span class='docblock autohide'><div class='impl-items'><h4 id='method.saturating_add-5' class="method"><span id='saturating_add.v-6' class='invisible'><code>fn <a href='#method.saturating_add' class='fnname'>saturating_add</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</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/saturating.rs.html#16-18' title='goto source code'>[src]</a></span></h4>
<h4 id='method.saturating_sub-5' class="method"><span id='saturating_sub.v-6' class='invisible'><code>fn <a href='#method.saturating_sub' class='fnname'>saturating_sub</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</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/saturating.rs.html#21-23' title='goto source code'>[src]</a></span></h4>
</div></span><h3 id='impl-Saturating-6' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num_traits/ops/saturating/trait.Saturating.html" title="trait num_traits::ops::saturating::Saturating">Saturating</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a href='#impl-Saturating-6' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/saturating.rs.html#14-24' title='goto source code'>[src]</a></span></h3>
<span class='docblock autohide'><div class='impl-items'><h4 id='method.saturating_add-6' class="method"><span id='saturating_add.v-7' class='invisible'><code>fn <a href='#method.saturating_add' class='fnname'>saturating_add</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</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/saturating.rs.html#16-18' title='goto source code'>[src]</a></span></h4>
<h4 id='method.saturating_sub-6' class="method"><span id='saturating_sub.v-7' class='invisible'><code>fn <a href='#method.saturating_sub' class='fnname'>saturating_sub</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</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/saturating.rs.html#21-23' title='goto source code'>[src]</a></span></h4>
</div></span><h3 id='impl-Saturating-7' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num_traits/ops/saturating/trait.Saturating.html" title="trait num_traits::ops::saturating::Saturating">Saturating</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code><a href='#impl-Saturating-7' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/saturating.rs.html#14-24' title='goto source code'>[src]</a></span></h3>
<span class='docblock autohide'><div class='impl-items'><h4 id='method.saturating_add-7' class="method"><span id='saturating_add.v-8' class='invisible'><code>fn <a href='#method.saturating_add' class='fnname'>saturating_add</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</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/saturating.rs.html#16-18' title='goto source code'>[src]</a></span></h4>
<h4 id='method.saturating_sub-7' class="method"><span id='saturating_sub.v-8' class='invisible'><code>fn <a href='#method.saturating_sub' class='fnname'>saturating_sub</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</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/saturating.rs.html#21-23' title='goto source code'>[src]</a></span></h4>
</div></span><h3 id='impl-Saturating-8' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num_traits/ops/saturating/trait.Saturating.html" title="trait num_traits::ops::saturating::Saturating">Saturating</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code><a href='#impl-Saturating-8' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/saturating.rs.html#14-24' title='goto source code'>[src]</a></span></h3>
<span class='docblock autohide'><div class='impl-items'><h4 id='method.saturating_add-8' class="method"><span id='saturating_add.v-9' class='invisible'><code>fn <a href='#method.saturating_add' class='fnname'>saturating_add</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</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/saturating.rs.html#16-18' title='goto source code'>[src]</a></span></h4>
<h4 id='method.saturating_sub-8' class="method"><span id='saturating_sub.v-9' class='invisible'><code>fn <a href='#method.saturating_sub' class='fnname'>saturating_sub</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</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/saturating.rs.html#21-23' title='goto source code'>[src]</a></span></h4>
</div></span><h3 id='impl-Saturating-9' class='impl'><span class='in-band'><code>impl <a class="trait" href="../num_traits/ops/saturating/trait.Saturating.html" title="trait num_traits::ops::saturating::Saturating">Saturating</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a href='#impl-Saturating-9' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/ops/saturating.rs.html#14-24' title='goto source code'>[src]</a></span></h3>
<span class='docblock autohide'><div class='impl-items'><h4 id='method.saturating_add-9' class="method"><span id='saturating_add.v-10' class='invisible'><code>fn <a href='#method.saturating_add' class='fnname'>saturating_add</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</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/saturating.rs.html#16-18' title='goto source code'>[src]</a></span></h4>
<h4 id='method.saturating_sub-9' class="method"><span id='saturating_sub.v-10' class='invisible'><code>fn <a href='#method.saturating_sub' class='fnname'>saturating_sub</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</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/saturating.rs.html#21-23' 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'>
</ul><script type="text/javascript" async
src="../implementors/num_traits/ops/saturating/trait.Saturating.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_traits";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>