mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 04:41:02 +01:00
18 lines
23 KiB
HTML
18 lines
23 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><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../num_traits/index.html">num_traits</a><span class="version">0.2.17</span></h2></div><h2 class="location"><a href="#">CheckedShl</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.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-i128">i128</a></li><li><a href="#impl-CheckedShl-for-i16">i16</a></li><li><a href="#impl-CheckedShl-for-i32">i32</a></li><li><a href="#impl-CheckedShl-for-i64">i64</a></li><li><a href="#impl-CheckedShl-for-i8">i8</a></li><li><a href="#impl-CheckedShl-for-isize">isize</a></li><li><a href="#impl-CheckedShl-for-u128">u128</a></li><li><a href="#impl-CheckedShl-for-u16">u16</a></li><li><a href="#impl-CheckedShl-for-u32">u32</a></li><li><a href="#impl-CheckedShl-for-u64">u64</a></li><li><a href="#impl-CheckedShl-for-u8">u8</a></li><li><a href="#impl-CheckedShl-for-usize">usize</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In num_traits::ops::checked</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../num_traits/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>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><button id="copy-path" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../src/num_traits/ops/checked.rs.html#188-203">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait CheckedShl: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/bit/trait.Shl.html" title="trait core::ops::bit::Shl">Shl</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/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.76.0/core/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/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.76.0/core/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/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="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</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.76.0/core/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.76.0/core/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/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.76.0/core/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.76.0/core/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/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.76.0/core/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.76.0/core/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/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.76.0/core/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.76.0/core/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/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.76.0/core/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.76.0/core/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/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.76.0/core/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.76.0/core/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/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.76.0/core/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.76.0/core/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/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.76.0/core/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.76.0/core/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/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.76.0/core/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.76.0/core/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/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.76.0/core/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.76.0/core/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/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.76.0/core/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.76.0/core/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/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.76.0/core/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.76.0/core/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/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="core" async></script></section></div></main></body></html> |