22 lines
22 KiB
HTML
22 lines
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="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="../../../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">☰</div><a href='../../../num_traits/index.html'><div class='logo-container'><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<T></a><a href="#impl-WrappingShl-for-i128">i128</a><a href="#impl-WrappingShl-for-i16">i16</a><a href="#impl-WrappingShl-for-i32">i32</a><a href="#impl-WrappingShl-for-i64">i64</a><a href="#impl-WrappingShl-for-i8">i8</a><a href="#impl-WrappingShl-for-isize">isize</a><a href="#impl-WrappingShl-for-u128">u128</a><a href="#impl-WrappingShl-for-u16">u16</a><a href="#impl-WrappingShl-for-u32">u32</a><a href="#impl-WrappingShl-for-u64">u64</a><a href="#impl-WrappingShl-for-u8">u8</a><a href="#impl-WrappingShl-for-usize">usize</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!"><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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" 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'>−</span>]</a></span><a class='srclink' href='../../../src/num_traits/ops/wrapping.rs.html#104-120' 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"
|
|||
|
|
fn <a href='#tymethod.wrapping_shl' class='fnname'>wrapping_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> 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 id='wrapping_shl.v'>fn <a href='#tymethod.wrapping_shl' class='fnname'>wrapping_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> Self</code></h3><div class='docblock'><p>Panic-free bitwise shift-left; yields <code>self << 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">&</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">&</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">&</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">&</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-u8' class='impl'><code class='in-band'>impl <a class="trait" href="../../../num_traits/ops/wrapping/trait.WrappingShl.html" title="trait num_traits::ops::wrapping::WrappingShl">WrappingShl</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a href='#impl-WrappingShl-for-u8' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/wrapping.rs.html#94-99' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.wrapping_shl' class="method hidden"><code id='wrapping_shl.v-1'>fn <a href='#method.wrapping_shl' class='fnname'>wrapping_shl</a>(&self, rhs: <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.u8.html">u8</a></code><a class='srclink' href='../../../src/num_traits/ops/wrapping.rs.html#96-98' title='goto source code'>[src]</a></h4></div><h3 id='impl-WrappingShl-for-u16' class='impl'><code class='in-band'>impl <a class="trait" href="../../../num_traits/ops/wrapping/trait.WrappingShl.html" title="trait num_traits::ops::wrapping::WrappingShl">WrappingShl</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code><a href='#impl-WrappingShl-for-u16' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/wrapping.rs.html#94-99' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.wrapping_shl-1' class="method hidden"><code id='wrapping_shl.v-2'>fn <a href='#method.wrapping_shl' class='fnname'>wrapping_shl</a>(&self, rhs: <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.u16.html">u16</a></code><a class='srclink' href='../../../src/num_traits/ops/wrapping.rs.html#96-98' title='goto source code'>[src]</a></h4></div><h3 id='impl-WrappingShl-for-u32' class='impl'><code class='in-band'>impl <a class="trait" href="../../../num_traits/ops/wrapping/trait.WrappingShl.html" title="trait num_traits::ops::wrapping::WrappingShl">WrappingShl</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a href='#impl-WrappingShl-for-u32' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/wrapping.rs.html#94-99' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.wrapping_shl-2' class="method hidden"><code id='wrapping_shl.v-3'>fn <a href='#method.wrapping_shl' class='fnname'>wrapping_shl</a>(&self, rhs: <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><a class='srclink' href='../../../src/num_traits/ops/wrapping.rs.html#96-98' title='goto source code'>[src]</a></h4></div><h3 id='impl-WrappingShl-for-u64' class='impl'><code class='in-band'>impl <a class="trait" href="../../../num_traits/ops/wrapping/trait.WrappingShl.html" title="trait num_traits::ops::wrapping::WrappingShl">WrappingShl</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code><a href='#impl-WrappingShl-for-u64' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/wrapping.rs.html#94-99' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.wrapping_shl-3' class="method hidden"><code id='wrapping_shl.v-4'>fn <a href='#method.wrapping_shl' class='fnname'>wrapping_shl</a>(&self, rhs: <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.u64.html">u64</a></code><a class='srclink' href='../../../src/num_traits/ops/wrappin
|
|||
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|||
|
|
src="../../../implementors/num_traits/ops/wrapping/trait.WrappingShl.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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><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>
|