blob: 8e49a46e171ac5dbb4f42343fe43d0d007854c6a [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 substraction with a flag for overflow."><meta name="keywords" content="rust, rustlang, rust-lang, OverflowingSub"><title>OverflowingSub in num_traits::ops::overflowing - 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" 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="sidebar-items.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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><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><h2></h2></nav><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><h2 class="location"><a href="#">OverflowingSub</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.overflowing_sub">overflowing_sub</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-OverflowingSub-for-i16">i16</a></li><li><a href="#impl-OverflowingSub-for-i32">i32</a></li><li><a href="#impl-OverflowingSub-for-i64">i64</a></li><li><a href="#impl-OverflowingSub-for-i8">i8</a></li><li><a href="#impl-OverflowingSub-for-isize">isize</a></li><li><a href="#impl-OverflowingSub-for-u16">u16</a></li><li><a href="#impl-OverflowingSub-for-u32">u32</a></li><li><a href="#impl-OverflowingSub-for-u64">u64</a></li><li><a href="#impl-OverflowingSub-for-u8">u8</a></li><li><a href="#impl-OverflowingSub-for-usize">usize</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In num_traits::ops::overflowing</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Trait <a href="../../index.html">num_traits</a>::<wbr><a href="../index.html">ops</a>::<wbr><a href="index.html">overflowing</a>::<wbr><a class="trait" href="#">OverflowingSub</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></h1><span class="out-of-band"><a class="srclink" href="../../../src/num_traits/ops/overflowing.rs.html#42-46">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="item-decl"><pre class="rust trait"><code>pub trait OverflowingSub: Sized + Sub&lt;Self, Output = Self&gt; {
fn <a href="#tymethod.overflowing_sub" class="fnname">overflowing_sub</a>(&amp;self, v: &amp;Self) -&gt; (Self, bool);
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Performs substraction with a flag for 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 method-toggle" open><summary><section id="tymethod.overflowing_sub" class="method has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#45">source</a><h4 class="code-header">fn <a href="#tymethod.overflowing_sub" class="fnname">overflowing_sub</a>(&amp;self, v: &amp;Self) -&gt; (Self, bool)</h4></section></summary><div class="docblock"><p>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.</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><section id="impl-OverflowingSub-for-u8" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#48">source</a><a href="#impl-OverflowingSub-for-u8" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.OverflowingSub.html" title="trait num_traits::ops::overflowing::OverflowingSub">OverflowingSub</a> for u8</h3></section></summary><div class="impl-items"><section id="method.overflowing_sub" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#48">source</a><a href="#method.overflowing_sub" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.overflowing_sub" class="fnname">overflowing_sub</a>(&amp;self, v: &amp;Self) -&gt; (Self, bool)</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-OverflowingSub-for-u16" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#49">source</a><a href="#impl-OverflowingSub-for-u16" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.OverflowingSub.html" title="trait num_traits::ops::overflowing::OverflowingSub">OverflowingSub</a> for u16</h3></section></summary><div class="impl-items"><section id="method.overflowing_sub-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#49">source</a><a href="#method.overflowing_sub-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.overflowing_sub" class="fnname">overflowing_sub</a>(&amp;self, v: &amp;Self) -&gt; (Self, bool)</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-OverflowingSub-for-u32" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#50">source</a><a href="#impl-OverflowingSub-for-u32" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.OverflowingSub.html" title="trait num_traits::ops::overflowing::OverflowingSub">OverflowingSub</a> for u32</h3></section></summary><div class="impl-items"><section id="method.overflowing_sub-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#50">source</a><a href="#method.overflowing_sub-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.overflowing_sub" class="fnname">overflowing_sub</a>(&amp;self, v: &amp;Self) -&gt; (Self, bool)</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-OverflowingSub-for-u64" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#51">source</a><a href="#impl-OverflowingSub-for-u64" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.OverflowingSub.html" title="trait num_traits::ops::overflowing::OverflowingSub">OverflowingSub</a> for u64</h3></section></summary><div class="impl-items"><section id="method.overflowing_sub-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#51">source</a><a href="#method.overflowing_sub-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.overflowing_sub" class="fnname">overflowing_sub</a>(&amp;self, v: &amp;Self) -&gt; (Self, bool)</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-OverflowingSub-for-usize" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#52">source</a><a href="#impl-OverflowingSub-for-usize" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.OverflowingSub.html" title="trait num_traits::ops::overflowing::OverflowingSub">OverflowingSub</a> for usize</h3></section></summary><div class="impl-items"><section id="method.overflowing_sub-4" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#52">source</a><a href="#method.overflowing_sub-4" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.overflowing_sub" class="fnname">overflowing_sub</a>(&amp;self, v: &amp;Self) -&gt; (Self, bool)</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-OverflowingSub-for-i8" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#56">source</a><a href="#impl-OverflowingSub-for-i8" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.OverflowingSub.html" title="trait num_traits::ops::overflowing::OverflowingSub">OverflowingSub</a> for i8</h3></section></summary><div class="impl-items"><section id="method.overflowing_sub-5" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#56">source</a><a href="#method.overflowing_sub-5" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.overflowing_sub" class="fnname">overflowing_sub</a>(&amp;self, v: &amp;Self) -&gt; (Self, bool)</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-OverflowingSub-for-i16" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#57">source</a><a href="#impl-OverflowingSub-for-i16" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.OverflowingSub.html" title="trait num_traits::ops::overflowing::OverflowingSub">OverflowingSub</a> for i16</h3></section></summary><div class="impl-items"><section id="method.overflowing_sub-6" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#57">source</a><a href="#method.overflowing_sub-6" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.overflowing_sub" class="fnname">overflowing_sub</a>(&amp;self, v: &amp;Self) -&gt; (Self, bool)</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-OverflowingSub-for-i32" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#58">source</a><a href="#impl-OverflowingSub-for-i32" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.OverflowingSub.html" title="trait num_traits::ops::overflowing::OverflowingSub">OverflowingSub</a> for i32</h3></section></summary><div class="impl-items"><section id="method.overflowing_sub-7" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#58">source</a><a href="#method.overflowing_sub-7" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.overflowing_sub" class="fnname">overflowing_sub</a>(&amp;self, v: &amp;Self) -&gt; (Self, bool)</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-OverflowingSub-for-i64" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#59">source</a><a href="#impl-OverflowingSub-for-i64" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.OverflowingSub.html" title="trait num_traits::ops::overflowing::OverflowingSub">OverflowingSub</a> for i64</h3></section></summary><div class="impl-items"><section id="method.overflowing_sub-8" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#59">source</a><a href="#method.overflowing_sub-8" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.overflowing_sub" class="fnname">overflowing_sub</a>(&amp;self, v: &amp;Self) -&gt; (Self, bool)</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-OverflowingSub-for-isize" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#60">source</a><a href="#impl-OverflowingSub-for-isize" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.OverflowingSub.html" title="trait num_traits::ops::overflowing::OverflowingSub">OverflowingSub</a> for isize</h3></section></summary><div class="impl-items"><section id="method.overflowing_sub-9" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/ops/overflowing.rs.html#60">source</a><a href="#method.overflowing_sub-9" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.overflowing_sub" class="fnname">overflowing_sub</a>(&amp;self, v: &amp;Self) -&gt; (Self, bool)</h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../../../implementors/num_traits/ops/overflowing/trait.OverflowingSub.js" data-ignore-extern-crates="core" async></script></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>