19 lines
15 KiB
HTML
19 lines
15 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 `CheckedShl` trait in crate `num_traits`."><meta name="keywords" content="rust, rustlang, rust-lang, CheckedShl"><title>num_traits::ops::checked::CheckedShl - 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 CheckedShl</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_shl">checked_shl</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: 'CheckedShl', 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'>−</span>]</a></span><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#200-215' 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=''>CheckedShl</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait CheckedShl: <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><u32, Output = Self> {
|
||
fn <a href='#tymethod.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
||
}</pre></div><div class='docblock'><p>Performs a left shift that returns <code>None</code> on shifts larger than
|
||
the type width.</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_shl' class='method'><code id='checked_shl.v'>fn <a href='#tymethod.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></code></h3><div class='docblock'><p>Checked shift left. Computes <code>self << rhs</code>, returning <code>None</code>
|
||
if <code>rhs</code> is larger than or equal to the number of bits in <code>self</code>.</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">CheckedShl</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">CheckedShl</span>::<span class="ident">checked_shl</span>(<span class="kw-2">&</span><span class="ident">x</span>, <span class="number">0</span>), <span class="prelude-val">Some</span>(<span class="number">0x0001</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CheckedShl</span>::<span class="ident">checked_shl</span>(<span class="kw-2">&</span><span class="ident">x</span>, <span class="number">1</span>), <span class="prelude-val">Some</span>(<span class="number">0x0002</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CheckedShl</span>::<span class="ident">checked_shl</span>(<span class="kw-2">&</span><span class="ident">x</span>, <span class="number">15</span>), <span class="prelude-val">Some</span>(<span class="number">0x8000</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CheckedShl</span>::<span class="ident">checked_shl</span>(<span class="kw-2">&</span><span class="ident">x</span>, <span class="number">16</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-CheckedShl' class='impl'><code class='in-band'>impl CheckedShl for i8</code><a href='#impl-CheckedShl' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#219-224' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_shl' class="method hidden"><code id='checked_shl.v-1'>fn <a href='#method.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><i8></code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#221-223' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedShl-1' class='impl'><code class='in-band'>impl CheckedShl for i16</code><a href='#impl-CheckedShl-1' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#219-224' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_shl-1' class="method hidden"><code id='checked_shl.v-2'>fn <a href='#method.checked_shl-1' class='fnname'>checked_shl</a>(&self, rhs: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><i16></code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#221-223' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedShl-2' class='impl'><code class='in-band'>impl CheckedShl for i32</code><a href='#impl-CheckedShl-2' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#219-224' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_shl-2' class="method hidden"><code id='checked_shl.v-3'>fn <a href='#method.checked_shl-2' class='fnname'>checked_shl</a>(&self, rhs: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><i32></code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#221-223' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedShl-3' class='impl'><code class='in-band'>impl CheckedShl for i64</code><a href='#impl-CheckedShl-3' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#219-224' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_shl-3' class="method hidden"><code id='checked_shl.v-4'>fn <a href='#method.checked_shl-3' class='fnname'>checked_shl</a>(&self, rhs: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><i64></code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#221-223' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedShl-4' class='impl'><code class='in-band'>impl CheckedShl for i128</code><a href='#impl-CheckedShl-4' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#219-224' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_shl-4' class="method hidden"><code id='checked_shl.v-5'>fn <a href='#method.checked_shl-4' class='fnname'>checked_shl</a>(&self, rhs: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><i128></code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#221-223' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedShl-5' class='impl'><code class='in-band'>impl CheckedShl for isize</code><a href='#impl-CheckedShl-5' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#219-224' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_shl-5' class="method hidden"><code id='checked_shl.v-6'>fn <a href='#method.checked_shl-5' class='fnname'>checked_shl</a>(&self, rhs: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><isize></code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#221-223' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedShl-6' class='impl'><code class='in-band'>impl CheckedShl for u8</code><a href='#impl-CheckedShl-6' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#219-224' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_shl-6' class="method hidden"><code id='checked_shl.v-7'>fn <a href='#method.checked_shl-6' class='fnname'>checked_shl</a>(&self, rhs: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><u8></code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#221-223' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedShl-7' class='impl'><code class='in-band'>impl CheckedShl for u16</code><a href='#impl-CheckedShl-7' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#219-224' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_shl-7' class="method hidden"><code id='checked_shl.v-8'>fn <a href='#method.checked_shl-7' class='fnname'>checked_shl</a>(&self, rhs: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><u16></code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#221-223' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedShl-8' class='impl'><code class='in-band'>impl CheckedShl for u32</code><a href='#impl-CheckedShl-8' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#219-224' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_shl-8' class="method hidden"><code id='checked_shl.v-9'>fn <a href='#method.checked_shl-8' class='fnname'>checked_shl</a>(&self, rhs: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><u32></code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#221-223' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedShl-9' class='impl'><code class='in-band'>impl CheckedShl for u64</code><a href='#impl-CheckedShl-9' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#219-224' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_shl-9' class="method hidden"><code id='checked_shl.v-10'>fn <a href='#method.checked_shl-9' class='fnname'>checked_shl</a>(&self, rhs: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><u64></code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#221-223' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedShl-10' class='impl'><code class='in-band'>impl CheckedShl for u128</code><a href='#impl-CheckedShl-10' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#219-224' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_shl-10' class="method hidden"><code id='checked_shl.v-11'>fn <a href='#method.checked_shl-10' class='fnname'>checked_shl</a>(&self, rhs: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><u128></code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#221-223' title='goto source code'>[src]</a></h4></div><h3 id='impl-CheckedShl-11' class='impl'><code class='in-band'>impl CheckedShl for usize</code><a href='#impl-CheckedShl-11' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#219-224' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.checked_shl-11' class="method hidden"><code id='checked_shl.v-12'>fn <a href='#method.checked_shl-11' class='fnname'>checked_shl</a>(&self, rhs: u32) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><usize></code><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#221-223' 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.CheckedShl.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> |