178 lines
No EOL
22 KiB
HTML
178 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="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="../../../main.css" id="themeStyle">
|
||
<script src="../../../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</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>
|
||
|
||
<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="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-CheckedShl">i32</a><a href="#impl-CheckedShl">u64</a><a href="#impl-CheckedShl">u16</a><a href="#impl-CheckedShl">i16</a><a href="#impl-CheckedShl">i8</a><a href="#impl-CheckedShl">u8</a><a href="#impl-CheckedShl">u32</a><a href="#impl-CheckedShl">i64</a><a href="#impl-CheckedShl">usize</a><a href="#impl-CheckedShl">isize</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 js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content">
|
||
<h1 class='fqn'><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><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#199-214' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust trait'>pub trait CheckedShl: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/bit/trait.Shl.html" title="trait core::ops::bit::Shl">Shl</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, Output = Self> {
|
||
fn <a href='#tymethod.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <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 class='docblock'><p>Performs a left shift that returns <code>None</code> on 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_shl' class='method'><span id='checked_shl.v' class='invisible'><code>fn <a href='#tymethod.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></code></span></h3><div class='docblock'><p>Shifts a number to the left, checking for overflow. If overflow happens,
|
||
<code>None</code> is returned.</p>
|
||
|
||
<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>
|
||
<h2 id='foreign-impls' class='small-section-header'>
|
||
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-CheckedShl' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../../num_traits/ops/checked/trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code><a href='#impl-CheckedShl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#218-223' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_shl' class="method"><span id='checked_shl.v-1' class='invisible'><code>fn <a href='#method.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#220-222' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedShl-1' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../../num_traits/ops/checked/trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code><a href='#impl-CheckedShl-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#218-223' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_shl-1' class="method"><span id='checked_shl.v-2' class='invisible'><code>fn <a href='#method.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#220-222' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedShl-2' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../../num_traits/ops/checked/trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code><a href='#impl-CheckedShl-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#218-223' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_shl-2' class="method"><span id='checked_shl.v-3' class='invisible'><code>fn <a href='#method.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#220-222' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedShl-3' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../../num_traits/ops/checked/trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></code><a href='#impl-CheckedShl-3' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#218-223' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_shl-3' class="method"><span id='checked_shl.v-4' class='invisible'><code>fn <a href='#method.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#220-222' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedShl-4' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../../num_traits/ops/checked/trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code><a href='#impl-CheckedShl-4' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#218-223' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_shl-4' class="method"><span id='checked_shl.v-5' class='invisible'><code>fn <a href='#method.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#220-222' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedShl-5' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../../num_traits/ops/checked/trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a href='#impl-CheckedShl-5' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#218-223' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_shl-5' class="method"><span id='checked_shl.v-6' class='invisible'><code>fn <a href='#method.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#220-222' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedShl-6' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../../num_traits/ops/checked/trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a href='#impl-CheckedShl-6' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#218-223' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_shl-6' class="method"><span id='checked_shl.v-7' class='invisible'><code>fn <a href='#method.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#220-222' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedShl-7' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../../num_traits/ops/checked/trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code><a href='#impl-CheckedShl-7' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#218-223' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_shl-7' class="method"><span id='checked_shl.v-8' class='invisible'><code>fn <a href='#method.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#220-222' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedShl-8' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../../num_traits/ops/checked/trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a href='#impl-CheckedShl-8' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#218-223' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_shl-8' class="method"><span id='checked_shl.v-9' class='invisible'><code>fn <a href='#method.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#220-222' title='goto source code'>[src]</a></span></h4>
|
||
</div></span><h3 id='impl-CheckedShl-9' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../../num_traits/ops/checked/trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></code><a href='#impl-CheckedShl-9' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#218-223' title='goto source code'>[src]</a></span></h3>
|
||
<span class='docblock autohide'><div class='impl-items'><h4 id='method.checked_shl-9' class="method"><span id='checked_shl.v-10' class='invisible'><code>fn <a href='#method.checked_shl' class='fnname'>checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/num_traits/ops/checked.rs.html#220-222' title='goto source code'>[src]</a></span></h4>
|
||
</div></span>
|
||
<h2 id='implementors' class='small-section-header'>
|
||
Implementors<a href='#implementors' class='anchor'></a>
|
||
</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
</ul><script type="text/javascript" async
|
||
src="../../../implementors/num_traits/ops/checked/trait.CheckedShl.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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../../";
|
||
window.currentCrate = "num_traits";
|
||
</script>
|
||
<script src="../../../main.js"></script>
|
||
<script defer src="../../../search-index.js"></script>
|
||
</body>
|
||
</html> |