9 lines
No EOL
22 KiB
HTML
9 lines
No EOL
22 KiB
HTML
<!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 addition that returns `None` instead of wrapping around on overflow."><title>CheckedAdd in num - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-fa3bb1812debf86c.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="num" data-themes="" data-resource-suffix="" data-rustdoc-version="1.74.0 (79e9716c9 2023-11-13)" data-channel="1.74.0" data-search-js="search-8be46b629f5f14a8.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-c5bd66d33317d69f.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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">☰</button><a class="logo-container" href="../num/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a></nav><nav class="sidebar"><a class="logo-container" href="../num/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">CheckedAdd</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.checked_add">checked_add</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-CheckedAdd-for-i128">i128</a></li><li><a href="#impl-CheckedAdd-for-i16">i16</a></li><li><a href="#impl-CheckedAdd-for-i32">i32</a></li><li><a href="#impl-CheckedAdd-for-i64">i64</a></li><li><a href="#impl-CheckedAdd-for-i8">i8</a></li><li><a href="#impl-CheckedAdd-for-isize">isize</a></li><li><a href="#impl-CheckedAdd-for-u128">u128</a></li><li><a href="#impl-CheckedAdd-for-u16">u16</a></li><li><a href="#impl-CheckedAdd-for-u32">u32</a></li><li><a href="#impl-CheckedAdd-for-u64">u64</a></li><li><a href="#impl-CheckedAdd-for-u8">u8</a></li><li><a href="#impl-CheckedAdd-for-usize">usize</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In num</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" 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="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">num</a>::<wbr><a class="trait" href="#">CheckedAdd</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/num_traits/ops/checked.rs.html#5">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait CheckedAdd: <a class="trait" href="https://doc.rust-lang.org/1.74.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.74.0/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a><Self, Output = Self> {
|
||
// Required method
|
||
fn <a href="#tymethod.checked_add" class="fn">checked_add</a>(&self, v: <a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.reference.html">&Self</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Performs addition that returns <code>None</code> instead of wrapping around on
|
||
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="toggle method-toggle" open><summary><section id="tymethod.checked_add" class="method"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#8">source</a><h4 class="code-header">fn <a href="#tymethod.checked_add" class="fn">checked_add</a>(&self, v: <a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.reference.html">&Self</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></h4></section></summary><div class="docblock"><p>Adds two numbers, checking for overflow. If overflow happens, <code>None</code> 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="toggle implementors-toggle"><summary><section id="impl-CheckedAdd-for-i128" class="impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#34">source</a><a href="#impl-CheckedAdd-for-i128" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i128.html">i128</a></h3></section></summary><div class="impl-items"><section id="method.checked_add" class="method trait-impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#34">source</a><a href="#method.checked_add" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_add" class="fn">checked_add</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i128.html">i128</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i128.html">i128</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedAdd-for-u32" class="impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#24">source</a><a href="#impl-CheckedAdd-for-u32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u32.html">u32</a></h3></section></summary><div class="impl-items"><section id="method.checked_add-1" class="method trait-impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#24">source</a><a href="#method.checked_add-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_add" class="fn">checked_add</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u32.html">u32</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedAdd-for-u128" class="impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#27">source</a><a href="#impl-CheckedAdd-for-u128" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u128.html">u128</a></h3></section></summary><div class="impl-items"><section id="method.checked_add-2" class="method trait-impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#27">source</a><a href="#method.checked_add-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_add" class="fn">checked_add</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u128.html">u128</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u128.html">u128</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedAdd-for-i64" class="impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#32">source</a><a href="#impl-CheckedAdd-for-i64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i64.html">i64</a></h3></section></summary><div class="impl-items"><section id="method.checked_add-3" class="method trait-impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#32">source</a><a href="#method.checked_add-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_add" class="fn">checked_add</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i64.html">i64</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i64.html">i64</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedAdd-for-isize" class="impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#33">source</a><a href="#impl-CheckedAdd-for-isize" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.isize.html">isize</a></h3></section></summary><div class="impl-items"><section id="method.checked_add-4" class="method trait-impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#33">source</a><a href="#method.checked_add-4" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_add" class="fn">checked_add</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.isize.html">isize</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.isize.html">isize</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedAdd-for-u8" class="impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#22">source</a><a href="#impl-CheckedAdd-for-u8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u8.html">u8</a></h3></section></summary><div class="impl-items"><section id="method.checked_add-5" class="method trait-impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#22">source</a><a href="#method.checked_add-5" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_add" class="fn">checked_add</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u8.html">u8</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u8.html">u8</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedAdd-for-i8" class="impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#29">source</a><a href="#impl-CheckedAdd-for-i8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i8.html">i8</a></h3></section></summary><div class="impl-items"><section id="method.checked_add-6" class="method trait-impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#29">source</a><a href="#method.checked_add-6" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_add" class="fn">checked_add</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i8.html">i8</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i8.html">i8</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedAdd-for-i16" class="impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#30">source</a><a href="#impl-CheckedAdd-for-i16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i16.html">i16</a></h3></section></summary><div class="impl-items"><section id="method.checked_add-7" class="method trait-impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#30">source</a><a href="#method.checked_add-7" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_add" class="fn">checked_add</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i16.html">i16</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i16.html">i16</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedAdd-for-i32" class="impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#31">source</a><a href="#impl-CheckedAdd-for-i32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i32.html">i32</a></h3></section></summary><div class="impl-items"><section id="method.checked_add-8" class="method trait-impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#31">source</a><a href="#method.checked_add-8" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_add" class="fn">checked_add</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i32.html">i32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.i32.html">i32</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedAdd-for-u16" class="impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#23">source</a><a href="#impl-CheckedAdd-for-u16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u16.html">u16</a></h3></section></summary><div class="impl-items"><section id="method.checked_add-9" class="method trait-impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#23">source</a><a href="#method.checked_add-9" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_add" class="fn">checked_add</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u16.html">u16</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u16.html">u16</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedAdd-for-usize" class="impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#26">source</a><a href="#impl-CheckedAdd-for-usize" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.usize.html">usize</a></h3></section></summary><div class="impl-items"><section id="method.checked_add-10" class="method trait-impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#26">source</a><a href="#method.checked_add-10" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_add" class="fn">checked_add</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.usize.html">usize</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedAdd-for-u64" class="impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#25">source</a><a href="#impl-CheckedAdd-for-u64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u64.html">u64</a></h3></section></summary><div class="impl-items"><section id="method.checked_add-11" class="method trait-impl"><a class="src rightside" href="../src/num_traits/ops/checked.rs.html#25">source</a><a href="#method.checked_add-11" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_add" class="fn">checked_add</a>(&self, v: &<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u64.html">u64</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.u64.html">u64</a>></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-CheckedAdd-for-BigInt" class="impl"><a class="src rightside" href="../src/num_bigint/bigint/addition.rs.html#232">source</a><a href="#impl-CheckedAdd-for-BigInt" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="struct" href="struct.BigInt.html" title="struct num::BigInt">BigInt</a></h3></section><section id="impl-CheckedAdd-for-BigUint" class="impl"><a class="src rightside" href="../src/num_bigint/biguint/addition.rs.html#247">source</a><a href="#impl-CheckedAdd-for-BigUint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="struct" href="struct.BigUint.html" title="struct num::BigUint">BigUint</a></h3></section><section id="impl-CheckedAdd-for-Ratio%3CT%3E" class="impl"><a class="src rightside" href="../src/num_rational/lib.rs.html#869">source</a><a href="#impl-CheckedAdd-for-Ratio%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a> for <a class="struct" href="rational/struct.Ratio.html" title="struct num::rational::Ratio">Ratio</a><T><span class="where fmt-newline">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.74.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="trait.Integer.html" title="trait num::Integer">Integer</a> + <a class="trait" href="trait.CheckedMul.html" title="trait num::CheckedMul">CheckedMul</a> + <a class="trait" href="trait.CheckedAdd.html" title="trait num::CheckedAdd">CheckedAdd</a>,</span></h3></section></div><script src="../implementors/num_traits/ops/checked/trait.CheckedAdd.js" data-ignore-extern-crates="num_bigint,std,num_rational" async></script></section></div></main></body></html> |