servius/rapr-rs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
7528fbbc3d7c3b29f26e5d3a67770e1ca7c7878f
rapr-rs/docs/num_traits/ops/wrapping/trait.WrappingShl.html
T
github-actions[bot] 799a22692f Auto Generated Documentation
2021-03-14 20:06:11 +00:00

20 lines
15 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 `WrappingShl` trait in crate `num_traits`."><meta name="keywords" content="rust, rustlang, rust-lang, WrappingShl"><title>num_traits::ops::wrapping::WrappingShl - 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="../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><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 rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a><p class="location">Trait WrappingShl</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.wrapping_shl">wrapping_shl</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-WrappingShl-for-Wrapping%3CT%3E">Wrapping&lt;T&gt;</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">wrapping</a></p><script>window.sidebarCurrent = {name: "WrappingShl", 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!" aria-haspopup="menu"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></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><button type="button" class="help-button">?</button>
<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/wrapping.rs.html#152-168" 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">wrapping</a>::<wbr><a class="trait" href="">WrappingShl</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait WrappingShl: <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/bit/trait.Shl.html" title="trait core::ops::bit::Shl">Shl</a>&lt;usize, Output = Self&gt; {
fn <a href="#tymethod.wrapping_shl" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; Self;
}</pre></div><div class="docblock"><p>Performs a left shift that does not panic.</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.wrapping_shl" class="method"><code>fn <a href="#tymethod.wrapping_shl" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; Self</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#167" title="goto source code">[src]</a></h3><div class="docblock"><p>Panic-free bitwise shift-left; yields <code>self &lt;&lt; mask(rhs)</code>,
where <code>mask</code> removes any high order bits of <code>rhs</code> that would
cause the shift to exceed the bitwidth of the type.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">WrappingShl</span>;
<span class="kw">let</span> <span class="ident">x</span>: <span class="ident">u16</span> <span class="op">=</span> <span class="number">0x0001</span>;
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">WrappingShl</span>::<span class="ident">wrapping_shl</span>(<span class="kw-2">&amp;</span><span class="ident">x</span>, <span class="number">0</span>), <span class="number">0x0001</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">WrappingShl</span>::<span class="ident">wrapping_shl</span>(<span class="kw-2">&amp;</span><span class="ident">x</span>, <span class="number">1</span>), <span class="number">0x0002</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">WrappingShl</span>::<span class="ident">wrapping_shl</span>(<span class="kw-2">&amp;</span><span class="ident">x</span>, <span class="number">15</span>), <span class="number">0x8000</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">WrappingShl</span>::<span class="ident">wrapping_shl</span>(<span class="kw-2">&amp;</span><span class="ident">x</span>, <span class="number">16</span>), <span class="number">0x0001</span>);</pre></div>
</div></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-WrappingShl-for-Wrapping%3CT%3E" class="impl"><code class="in-band">impl&lt;T:&nbsp;<a class="trait" href="../../../num_traits/ops/wrapping/trait.WrappingShl.html" title="trait num_traits::ops::wrapping::WrappingShl">WrappingShl</a>&gt; <a class="trait" href="../../../num_traits/ops/wrapping/trait.WrappingShl.html" title="trait num_traits::ops::wrapping::WrappingShl">WrappingShl</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a>&lt;T&gt;: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/bit/trait.Shl.html" title="trait core::ops::bit::Shl">Shl</a>&lt;usize, Output = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a>&lt;T&gt;&gt;,&nbsp;</span></code><a href="#impl-WrappingShl-for-Wrapping%3CT%3E" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#254-261" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_shl" class="method hidden"><code>fn <a href="#method.wrapping_shl" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; Self</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#258-260" title="goto source code">[src]</a></h4></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-WrappingShl" class="impl"><code class="in-band">impl WrappingShl for i8</code><a href="#impl-WrappingShl" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#178" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_shl-1" class="method hidden"><code>fn <a href="#method.wrapping_shl-1" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; i8</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#178" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingShl-1" class="impl"><code class="in-band">impl WrappingShl for i16</code><a href="#impl-WrappingShl-1" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#179" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_shl-2" class="method hidden"><code>fn <a href="#method.wrapping_shl-2" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; i16</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#179" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingShl-2" class="impl"><code class="in-band">impl WrappingShl for i32</code><a href="#impl-WrappingShl-2" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#180" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_shl-3" class="method hidden"><code>fn <a href="#method.wrapping_shl-3" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; i32</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#180" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingShl-3" class="impl"><code class="in-band">impl WrappingShl for i64</code><a href="#impl-WrappingShl-3" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#181" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_shl-4" class="method hidden"><code>fn <a href="#method.wrapping_shl-4" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; i64</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#181" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingShl-4" class="impl"><code class="in-band">impl WrappingShl for i128</code><a href="#impl-WrappingShl-4" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#184" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_shl-5" class="method hidden"><code>fn <a href="#method.wrapping_shl-5" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; i128</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#184" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingShl-5" class="impl"><code class="in-band">impl WrappingShl for isize</code><a href="#impl-WrappingShl-5" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#182" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_shl-6" class="method hidden"><code>fn <a href="#method.wrapping_shl-6" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; isize</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#182" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingShl-6" class="impl"><code class="in-band">impl WrappingShl for u8</code><a href="#impl-WrappingShl-6" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#170" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_shl-7" class="method hidden"><code>fn <a href="#method.wrapping_shl-7" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; u8</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#170" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingShl-7" class="impl"><code class="in-band">impl WrappingShl for u16</code><a href="#impl-WrappingShl-7" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#171" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_shl-8" class="method hidden"><code>fn <a href="#method.wrapping_shl-8" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; u16</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#171" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingShl-8" class="impl"><code class="in-band">impl WrappingShl for u32</code><a href="#impl-WrappingShl-8" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#172" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_shl-9" class="method hidden"><code>fn <a href="#method.wrapping_shl-9" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; u32</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#172" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingShl-9" class="impl"><code class="in-band">impl WrappingShl for u64</code><a href="#impl-WrappingShl-9" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#173" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_shl-10" class="method hidden"><code>fn <a href="#method.wrapping_shl-10" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; u64</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#173" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingShl-10" class="impl"><code class="in-band">impl WrappingShl for u128</code><a href="#impl-WrappingShl-10" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#176" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_shl-11" class="method hidden"><code>fn <a href="#method.wrapping_shl-11" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; u128</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#176" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingShl-11" class="impl"><code class="in-band">impl WrappingShl for usize</code><a href="#impl-WrappingShl-11" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#174" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_shl-12" class="method hidden"><code>fn <a href="#method.wrapping_shl-12" class="fnname">wrapping_shl</a>(&amp;self, rhs: u32) -&gt; usize</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#174" 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/wrapping/trait.WrappingShl.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="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink