16 lines
22 KiB
HTML
16 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="Performs a left shift that returns `None` on shifts larger than or equal to the type width."><title>CheckedShl in num_traits::ops::checked - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="num_traits" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">CheckedShl</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../num_traits/index.html">num_<wbr>traits</a><span class="version">0.2.19</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Checked<wbr>Shl</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.checked_shl" title="checked_shl">checked_shl</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-CheckedShl-for-i8" title="i8">i8</a></li><li><a href="#impl-CheckedShl-for-i16" title="i16">i16</a></li><li><a href="#impl-CheckedShl-for-i32" title="i32">i32</a></li><li><a href="#impl-CheckedShl-for-i64" title="i64">i64</a></li><li><a href="#impl-CheckedShl-for-i128" title="i128">i128</a></li><li><a href="#impl-CheckedShl-for-isize" title="isize">isize</a></li><li><a href="#impl-CheckedShl-for-u8" title="u8">u8</a></li><li><a href="#impl-CheckedShl-for-u16" title="u16">u16</a></li><li><a href="#impl-CheckedShl-for-u32" title="u32">u32</a></li><li><a href="#impl-CheckedShl-for-u64" title="u64">u64</a></li><li><a href="#impl-CheckedShl-for-u128" title="u128">u128</a></li><li><a href="#impl-CheckedShl-for-usize" title="usize">usize</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In num_<wbr>traits::<wbr>ops::<wbr>checked</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">num_traits</a>::<wbr><a href="../index.html">ops</a>::<wbr><a href="index.html">checked</a></div><h1>Trait <span class="trait">Checked<wbr>Shl</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/num_traits/ops/checked.rs.html#188-203">Source</a> </span></div><pre class="rust item-decl"><code>pub trait CheckedShl: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/bit/trait.Shl.html" title="trait core::ops::bit::Shl">Shl</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>, Output = Self> {
|
|
// Required method
|
|
fn <a href="#tymethod.checked_shl" class="fn">checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Performs a left shift that returns <code>None</code> on shifts larger than
|
|
or equal to the type width.</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.checked_shl" class="method"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#202">Source</a><h4 class="code-header">fn <a href="#tymethod.checked_shl" class="fn">checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></h4></section></summary><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"><code><span class="kw">use </span>num_traits::CheckedShl;
|
|
|
|
<span class="kw">let </span>x: u16 = <span class="number">0x0001</span>;
|
|
|
|
<span class="macro">assert_eq!</span>(CheckedShl::checked_shl(<span class="kw-2">&</span>x, <span class="number">0</span>), <span class="prelude-val">Some</span>(<span class="number">0x0001</span>));
|
|
<span class="macro">assert_eq!</span>(CheckedShl::checked_shl(<span class="kw-2">&</span>x, <span class="number">1</span>), <span class="prelude-val">Some</span>(<span class="number">0x0002</span>));
|
|
<span class="macro">assert_eq!</span>(CheckedShl::checked_shl(<span class="kw-2">&</span>x, <span class="number">15</span>), <span class="prelude-val">Some</span>(<span class="number">0x8000</span>));
|
|
<span class="macro">assert_eq!</span>(CheckedShl::checked_shl(<span class="kw-2">&</span>x, <span class="number">16</span>), <span class="prelude-val">None</span>);</code></pre></div></div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.93.1/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-CheckedShl-for-i8" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#223">Source</a><a href="#impl-CheckedShl-for-i8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i8.html">i8</a></h3></section></summary><div class="impl-items"><section id="method.checked_shl" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#223">Source</a><a href="#method.checked_shl" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_shl" class="fn">checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i8.html">i8</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedShl-for-i16" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#224">Source</a><a href="#impl-CheckedShl-for-i16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i16.html">i16</a></h3></section></summary><div class="impl-items"><section id="method.checked_shl-1" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#224">Source</a><a href="#method.checked_shl-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_shl" class="fn">checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i16.html">i16</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedShl-for-i32" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#225">Source</a><a href="#impl-CheckedShl-for-i32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i32.html">i32</a></h3></section></summary><div class="impl-items"><section id="method.checked_shl-2" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#225">Source</a><a href="#method.checked_shl-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_shl" class="fn">checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i32.html">i32</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedShl-for-i64" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#226">Source</a><a href="#impl-CheckedShl-for-i64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i64.html">i64</a></h3></section></summary><div class="impl-items"><section id="method.checked_shl-3" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#226">Source</a><a href="#method.checked_shl-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_shl" class="fn">checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i64.html">i64</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedShl-for-i128" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#228">Source</a><a href="#impl-CheckedShl-for-i128" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i128.html">i128</a></h3></section></summary><div class="impl-items"><section id="method.checked_shl-4" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#228">Source</a><a href="#method.checked_shl-4" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_shl" class="fn">checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i128.html">i128</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedShl-for-isize" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#227">Source</a><a href="#impl-CheckedShl-for-isize" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.isize.html">isize</a></h3></section></summary><div class="impl-items"><section id="method.checked_shl-5" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#227">Source</a><a href="#method.checked_shl-5" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_shl" class="fn">checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.isize.html">isize</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedShl-for-u8" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#216">Source</a><a href="#impl-CheckedShl-for-u8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a></h3></section></summary><div class="impl-items"><section id="method.checked_shl-6" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#216">Source</a><a href="#method.checked_shl-6" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_shl" class="fn">checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedShl-for-u16" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#217">Source</a><a href="#impl-CheckedShl-for-u16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u16.html">u16</a></h3></section></summary><div class="impl-items"><section id="method.checked_shl-7" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#217">Source</a><a href="#method.checked_shl-7" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_shl" class="fn">checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u16.html">u16</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedShl-for-u32" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#218">Source</a><a href="#impl-CheckedShl-for-u32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a></h3></section></summary><div class="impl-items"><section id="method.checked_shl-8" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#218">Source</a><a href="#method.checked_shl-8" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_shl" class="fn">checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedShl-for-u64" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#219">Source</a><a href="#impl-CheckedShl-for-u64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u64.html">u64</a></h3></section></summary><div class="impl-items"><section id="method.checked_shl-9" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#219">Source</a><a href="#method.checked_shl-9" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_shl" class="fn">checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u64.html">u64</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedShl-for-u128" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#221">Source</a><a href="#impl-CheckedShl-for-u128" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u128.html">u128</a></h3></section></summary><div class="impl-items"><section id="method.checked_shl-10" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#221">Source</a><a href="#method.checked_shl-10" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_shl" class="fn">checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u128.html">u128</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CheckedShl-for-usize" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#220">Source</a><a href="#impl-CheckedShl-for-usize" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a></h3></section></summary><div class="impl-items"><section id="method.checked_shl-11" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/checked.rs.html#220">Source</a><a href="#method.checked_shl-11" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_shl" class="fn">checked_shl</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../trait.impl/num_traits/ops/checked/trait.CheckedShl.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html> |