Mercator/mercator_service
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Files
527969729d50e57b483610ffacaa016c42441eac
mercator_service/num_traits/ops/checked/trait.CheckedRem.html

23 lines
17 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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 `CheckedRem` trait in crate `num_traits`."><meta name="keywords" content="rust, rustlang, rust-lang, CheckedRem"><title>num_traits::ops::checked::CheckedRem - 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="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></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">&#9776;</div><a href='../../../num_traits/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait CheckedRem</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.checked_rem">checked_rem</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../index.html'>num_traits</a>::<wbr><a href='../index.html'>ops</a>::<wbr><a href='index.html'>checked</a></p><script>window.sidebarCurrent = {name: 'CheckedRem', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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'>&#x2212;</span>]</a></span><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#111-132' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../index.html'>num_traits</a>::<wbr><a href='../index.html'>ops</a>::<wbr><a href='index.html'>checked</a>::<wbr><a class="trait" href=''>CheckedRem</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait CheckedRem: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Rem.html" title="trait core::ops::arith::Rem">Rem</a>&lt;Self, Output = Self&gt; {
fn <a href='#tymethod.checked_rem' class='fnname'>checked_rem</a>(&amp;self, v: &amp;Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;;
}</pre></div><div class='docblock'><p>Performs an integral remainder that returns <code>None</code> instead of panicking on division by zero and
instead of wrapping around on underflow and overflow.</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.checked_rem' class='method'><code id='checked_rem.v'>fn <a href='#tymethod.checked_rem' class='fnname'>checked_rem</a>(&amp;self, v: &amp;Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;</code></h3><div class='docblock'><p>Finds the remainder of dividing two numbers, checking for underflow, overflow and division
by zero. If any of that happens, <code>None</code> is returned.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">CheckedRem</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">i32</span>::<span class="ident">MIN</span>;
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CheckedRem</span>::<span class="ident">checked_rem</span>(<span class="kw-2">&amp;</span><span class="number">10</span>, <span class="kw-2">&amp;</span><span class="number">7</span>), <span class="prelude-val">Some</span>(<span class="number">3</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CheckedRem</span>::<span class="ident">checked_rem</span>(<span class="kw-2">&amp;</span><span class="number">10</span>, <span class="kw-2">&amp;</span><span class="op">-</span><span class="number">7</span>), <span class="prelude-val">Some</span>(<span class="number">3</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CheckedRem</span>::<span class="ident">checked_rem</span>(<span class="kw-2">&amp;</span><span class="op">-</span><span class="number">10</span>, <span class="kw-2">&amp;</span><span class="number">7</span>), <span class="prelude-val">Some</span>(<span class="op">-</span><span class="number">3</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CheckedRem</span>::<span class="ident">checked_rem</span>(<span class="kw-2">&amp;</span><span class="op">-</span><span class="number">10</span>, <span class="kw-2">&amp;</span><span class="op">-</span><span class="number">7</span>), <span class="prelude-val">Some</span>(<span class="op">-</span><span class="number">3</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CheckedRem</span>::<span class="ident">checked_rem</span>(<span class="kw-2">&amp;</span><span class="number">10</span>, <span class="kw-2">&amp;</span><span class="number">0</span>), <span class="prelude-val">None</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CheckedRem</span>::<span class="ident">checked_rem</span>(<span class="kw-2">&amp;</span><span class="ident">MIN</span>, <span class="kw-2">&amp;</span><span class="number">1</span>), <span class="prelude-val">Some</span>(<span class="number">0</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CheckedRem</span>::<span class="ident">checked_rem</span>(<span class="kw-2">&amp;</span><span class="ident">MIN</span>, <span class="kw-2">&amp;</span><span class="op">-</span><span class="number">1</span>), <span class="prelude-val">None</span>);</pre></div>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-CheckedRem' class='impl'><code class='in-band'>impl CheckedRem for i8</code><a href='#impl-CheckedRem' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_rem' class="method hidden"><code id='checked_rem.v-1'>fn <a href='#method.checked_rem' class='fnname'>checked_rem</a>(&amp;self, v: &amp;i8) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;i8&gt;</code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedRem-1' class='impl'><code class='in-band'>impl CheckedRem for i16</code><a href='#impl-CheckedRem-1' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_rem-1' class="method hidden"><code id='checked_rem.v-2'>fn <a href='#method.checked_rem-1' class='fnname'>checked_rem</a>(&amp;self, v: &amp;i16) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;i16&gt;</code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedRem-2' class='impl'><code class='in-band'>impl CheckedRem for i32</code><a href='#impl-CheckedRem-2' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_rem-2' class="method hidden"><code id='checked_rem.v-3'>fn <a href='#method.checked_rem-2' class='fnname'>checked_rem</a>(&amp;self, v: &amp;i32) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;i32&gt;</code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedRem-3' class='impl'><code class='in-band'>impl CheckedRem for i64</code><a href='#impl-CheckedRem-3' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_rem-3' class="method hidden"><code id='checked_rem.v-4'>fn <a href='#method.checked_rem-3' class='fnname'>checked_rem</a>(&amp;self, v: &amp;i64) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;i64&gt;</code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedRem-4' class='impl'><code class='in-band'>impl CheckedRem for i128</code><a href='#impl-CheckedRem-4' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_rem-4' class="method hidden"><code id='checked_rem.v-5'>fn <a href='#method.checked_rem-4' class='fnname'>checked_rem</a>(&amp;self, v: &amp;i128) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;i128&gt;</code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedRem-5' class='impl'><code class='in-band'>impl CheckedRem for isize</code><a href='#impl-CheckedRem-5' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_rem-5' class="method hidden"><code id='checked_rem.v-6'>fn <a href='#method.checked_rem-5' class='fnname'>checked_rem</a>(&amp;self, v: &amp;isize) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;isize&gt;</code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedRem-6' class='impl'><code class='in-band'>impl CheckedRem for u8</code><a href='#impl-CheckedRem-6' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_rem-6' class="method hidden"><code id='checked_rem.v-7'>fn <a href='#method.checked_rem-6' class='fnname'>checked_rem</a>(&amp;self, v: &amp;u8) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;u8&gt;</code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedRem-7' class='impl'><code class='in-band'>impl CheckedRem for u16</code><a href='#impl-CheckedRem-7' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_rem-7' class="method hidden"><code id='checked_rem.v-8'>fn <a href='#method.checked_rem-7' class='fnname'>checked_rem</a>(&amp;self, v: &amp;u16) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;u16&gt;</code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedRem-8' class='impl'><code class='in-band'>impl CheckedRem for u32</code><a href='#impl-CheckedRem-8' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_rem-8' class="method hidden"><code id='checked_rem.v-9'>fn <a href='#method.checked_rem-8' class='fnname'>checked_rem</a>(&amp;self, v: &amp;u32) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;u32&gt;</code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedRem-9' class='impl'><code class='in-band'>impl CheckedRem for u64</code><a href='#impl-CheckedRem-9' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_rem-9' class="method hidden"><code id='checked_rem.v-10'>fn <a href='#method.checked_rem-9' class='fnname'>checked_rem</a>(&amp;self, v: &amp;u64) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;u64&gt;</code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedRem-10' class='impl'><code class='in-band'>impl CheckedRem for u128</code><a href='#impl-CheckedRem-10' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_rem-10' class="method hidden"><code id='checked_rem.v-11'>fn <a href='#method.checked_rem-10' class='fnname'>checked_rem</a>(&amp;self, v: &amp;u128) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;u128&gt;</code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedRem-11' class='impl'><code class='in-band'>impl CheckedRem for usize</code><a href='#impl-CheckedRem-11' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#13-18' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_rem-11' class="method hidden"><code id='checked_rem.v-12'>fn <a href='#method.checked_rem-11' class='fnname'>checked_rem</a>(&amp;self, v: &amp;usize) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;usize&gt;</code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#15-17' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript" src="../../../implementors/num_traits/ops/checked/trait.CheckedRem.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../../";window.currentCrate = "num_traits";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink