mitchellhansen/Trac3r-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add doc

Browse Source
This commit is contained in:
mitchellhansen
2020-01-23 23:13:36 -08:00
parent dcc0df955e
commit 2bc9ebdc6b
31829 changed files with 1229378 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
doc/typenum/uint/index.html Normal file
View File

@@ -0,0 +1,37 @@
<!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 `uint` mod in crate `typenum`."><meta name="keywords" content="rust, rustlang, rust-lang, uint"><title>typenum::uint - 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 mod"><!--[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">&#9776;</div><a href='../../typenum/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module uint</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>typenum</a></p><script>window.sidebarCurrent = {name: 'uint', ty: 'mod', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/typenum/uint.rs.html#1-1572' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>typenum</a>::<wbr><a class="mod" href=''>uint</a></span></h1><div class='docblock'><p>Type-level unsigned integers.</p>
<p><strong>Type operators</strong> implemented:</p>
<p>From <code>core::ops</code>: <code>BitAnd</code>, <code>BitOr</code>, <code>BitXor</code>, <code>Shl</code>, <code>Shr</code>, <code>Add</code>, <code>Sub</code>,
<code>Mul</code>, <code>Div</code>, and <code>Rem</code>.
From <code>typenum</code>: <code>Same</code>, <code>Cmp</code>, and <code>Pow</code>.</p>
<p>Rather than directly using the structs defined in this module, it is recommended that
you import and use the relevant aliases from the <a href="../consts/index.html">consts</a> module.</p>
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::{<span class="ident">BitAnd</span>, <span class="ident">BitOr</span>, <span class="ident">BitXor</span>, <span class="ident">Shl</span>, <span class="ident">Shr</span>, <span class="ident">Add</span>, <span class="ident">Sub</span>, <span class="ident">Mul</span>, <span class="ident">Div</span>, <span class="ident">Rem</span>};
<span class="kw">use</span> <span class="ident">typenum</span>::{<span class="ident">Unsigned</span>, <span class="ident">U1</span>, <span class="ident">U2</span>, <span class="ident">U3</span>, <span class="ident">U4</span>};
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">U3</span> <span class="kw">as</span> <span class="ident">BitAnd</span><span class="op">&lt;</span><span class="ident">U2</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_u32</span>(), <span class="number">2</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">U3</span> <span class="kw">as</span> <span class="ident">BitOr</span><span class="op">&lt;</span><span class="ident">U4</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_u32</span>(), <span class="number">7</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">U3</span> <span class="kw">as</span> <span class="ident">BitXor</span><span class="op">&lt;</span><span class="ident">U2</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_u32</span>(), <span class="number">1</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">U3</span> <span class="kw">as</span> <span class="ident">Shl</span><span class="op">&lt;</span><span class="ident">U1</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_u32</span>(), <span class="number">6</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">U3</span> <span class="kw">as</span> <span class="ident">Shr</span><span class="op">&lt;</span><span class="ident">U1</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_u32</span>(), <span class="number">1</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">U3</span> <span class="kw">as</span> <span class="ident">Add</span><span class="op">&lt;</span><span class="ident">U2</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_u32</span>(), <span class="number">5</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">U3</span> <span class="kw">as</span> <span class="ident">Sub</span><span class="op">&lt;</span><span class="ident">U2</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_u32</span>(), <span class="number">1</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">U3</span> <span class="kw">as</span> <span class="ident">Mul</span><span class="op">&lt;</span><span class="ident">U2</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_u32</span>(), <span class="number">6</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">U3</span> <span class="kw">as</span> <span class="ident">Div</span><span class="op">&lt;</span><span class="ident">U2</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_u32</span>(), <span class="number">1</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">U3</span> <span class="kw">as</span> <span class="ident">Rem</span><span class="op">&lt;</span><span class="ident">U2</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_u32</span>(), <span class="number">1</span>);</pre></div>
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
<table><tr><td><code>pub use marker_traits::<a class="trait" href="../../typenum/marker_traits/trait.PowerOfTwo.html" title="trait typenum::marker_traits::PowerOfTwo">PowerOfTwo</a>;</code></td></tr><tr><td><code>pub use marker_traits::<a class="trait" href="../../typenum/marker_traits/trait.Unsigned.html" title="trait typenum::marker_traits::Unsigned">Unsigned</a>;</code></td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.UInt.html" title='typenum::uint::UInt struct'>UInt</a></td><td class='docblock-short'><p><code>UInt</code> is defined recursively, where <code>B</code> is the least significant bit and <code>U</code> is the rest
of the number. Conceptually, <code>U</code> should be bound by the trait <code>Unsigned</code> and <code>B</code> should
be bound by the trait <code>Bit</code>, but enforcing these bounds causes linear instead of
logrithmic scaling in some places, so they are left off for now. They may be enforced in
future.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.UTerm.html" title='typenum::uint::UTerm struct'>UTerm</a></td><td class='docblock-short'><p>The terminating type for <code>UInt</code>; it always comes after the most significant
bit. <code>UTerm</code> by itself represents zero, which is aliased to <code>U0</code>.</p>
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table><tr class='module-item'><td><a class="trait" href="trait.GetBit.html" title='typenum::uint::GetBit trait'>GetBit</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="trait" href="trait.SetBit.html" title='typenum::uint::SetBit trait'>SetBit</a></td><td class='docblock-short'><p>A <strong>type operator</strong> that, when implemented for unsigned integer <code>N</code>, sets the bit at position
<code>I</code> to <code>B</code>.</p>
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table><tr class='module-item'><td><a class="type" href="type.GetBitOut.html" title='typenum::uint::GetBitOut type'>GetBitOut</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="type" href="type.SetBitOut.html" title='typenum::uint::SetBitOut type'>SetBitOut</a></td><td class='docblock-short'><p>Alias for the result of calling <code>SetBit</code>: <code>SetBitOut&lt;N, I, B&gt; = &lt;N as SetBit&lt;I, B&gt;&gt;::Output</code>.</p>
</td></tr></table></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>&#9166;</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 = "typenum";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>

1
doc/typenum/uint/sidebar-items.js Normal file
View File

@@ -0,0 +1 @@
initSidebarItems({"struct":[["UInt","`UInt` is defined recursively, where `B` is the least significant bit and `U` is the rest of the number. Conceptually, `U` should be bound by the trait `Unsigned` and `B` should be bound by the trait `Bit`, but enforcing these bounds causes linear instead of logrithmic scaling in some places, so they are left off for now. They may be enforced in future."],["UTerm","The terminating type for `UInt`; it always comes after the most significant bit. `UTerm` by itself represents zero, which is aliased to `U0`."]],"trait":[["GetBit",""],["SetBit","A type operator that, when implemented for unsigned integer `N`, sets the bit at position `I` to `B`."]],"type":[["GetBitOut",""],["SetBitOut","Alias for the result of calling `SetBit`: `SetBitOut<N, I, B> = <N as SetBit<I, B>>::Output`."]]});

213
doc/typenum/uint/struct.UInt.html Normal file
View File

File diff suppressed because one or more lines are too long

161
doc/typenum/uint/struct.UTerm.html Normal file
View File

File diff suppressed because one or more lines are too long

7
doc/typenum/uint/trait.GetBit.html Normal file
View File

@@ -0,0 +1,7 @@
<!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 `GetBit` trait in crate `typenum`."><meta name="keywords" content="rust, rustlang, rust-lang, GetBit"><title>typenum::uint::GetBit - 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">&#9776;</div><a href='../../typenum/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait GetBit</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Output">Output</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>typenum</a>::<wbr><a href='index.html'>uint</a></p><script>window.sidebarCurrent = {name: 'GetBit', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/typenum/uint.rs.html#1066-1069' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>typenum</a>::<wbr><a href='index.html'>uint</a>::<wbr><a class="trait" href=''>GetBit</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait GetBit&lt;I&gt; {
type <a href='#associatedtype.Output' class="type">Output</a>;
}</pre></div>
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Output' class='method'><code id='Output.t'>type <a href='#associatedtype.Output' class="type">Output</a></code></h3></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-GetBit%3CI%3E' class='impl'><code class='in-band'>impl&lt;I&gt; GetBit&lt;I&gt; for <a class="struct" href="../../typenum/uint/struct.UTerm.html" title="struct typenum::uint::UTerm">UTerm</a></code><a href='#impl-GetBit%3CI%3E' class='anchor'></a><a class='srclink' href='../../src/typenum/uint.rs.html#1089-1091' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Output-1' class="type"><code id='Output.t-1'>type <a href='#associatedtype.Output-1' class="type">Output</a> = <a class="struct" href="../../typenum/bit/struct.B0.html" title="struct typenum::bit::B0">B0</a></code></h4></div><h3 id='impl-GetBit%3CUTerm%3E' class='impl'><code class='in-band'>impl&lt;Un, Bn&gt; GetBit&lt;<a class="struct" href="../../typenum/uint/struct.UTerm.html" title="struct typenum::uint::UTerm">UTerm</a>&gt; for <a class="struct" href="../../typenum/uint/struct.UInt.html" title="struct typenum::uint::UInt">UInt</a>&lt;Un, Bn&gt;</code><a href='#impl-GetBit%3CUTerm%3E' class='anchor'></a><a class='srclink' href='../../src/typenum/uint.rs.html#1075-1077' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Output-2' class="type"><code id='Output.t-2'>type <a href='#associatedtype.Output-2' class="type">Output</a> = Bn</code></h4></div><h3 id='impl-GetBit%3CUInt%3CUi%2C%20Bi%3E%3E' class='impl'><code class='in-band'>impl&lt;Un, Bn, Ui, Bi&gt; GetBit&lt;<a class="struct" href="../../typenum/uint/struct.UInt.html" title="struct typenum::uint::UInt">UInt</a>&lt;Ui, Bi&gt;&gt; for <a class="struct" href="../../typenum/uint/struct.UInt.html" title="struct typenum::uint::UInt">UInt</a>&lt;Un, Bn&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="../../typenum/uint/struct.UInt.html" title="struct typenum::uint::UInt">UInt</a>&lt;Ui, Bi&gt;: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Sub.html" title="trait core::ops::arith::Sub">Sub</a>&lt;<a class="struct" href="../../typenum/bit/struct.B1.html" title="struct typenum::bit::B1">B1</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;Un: <a class="trait" href="../../typenum/uint/trait.GetBit.html" title="trait typenum::uint::GetBit">GetBit</a>&lt;<a class="type" href="../../typenum/operator_aliases/type.Sub1.html" title="type typenum::operator_aliases::Sub1">Sub1</a>&lt;<a class="struct" href="../../typenum/uint/struct.UInt.html" title="struct typenum::uint::UInt">UInt</a>&lt;Ui, Bi&gt;&gt;&gt;,&nbsp;</span></code><a href='#impl-GetBit%3CUInt%3CUi%2C%20Bi%3E%3E' class='anchor'></a><a class='srclink' href='../../src/typenum/uint.rs.html#1080-1086' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Output-3' class="type"><code id='Output.t-3'>type <a href='#associatedtype.Output-3' class="type">Output</a> = <a class="type" href="../../typenum/uint/type.GetBitOut.html" title="type typenum::uint::GetBitOut">GetBitOut</a>&lt;Un, <a class="type" href="../../typenum/operator_aliases/type.Sub1.html" title="type typenum::operator_aliases::Sub1">Sub1</a>&lt;<a class="struct" href="../../typenum/uint/struct.UInt.html" title="struct typenum::uint::UInt">UInt</a>&lt;Ui, Bi&gt;&gt;&gt;</code></h4></div></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/typenum/uint/trait.GetBit.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>&#9166;</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 = "typenum";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>

9
doc/typenum/uint/trait.SetBit.html Normal file
View File

@@ -0,0 +1,9 @@
<!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 `SetBit` trait in crate `typenum`."><meta name="keywords" content="rust, rustlang, rust-lang, SetBit"><title>typenum::uint::SetBit - 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">&#9776;</div><a href='../../typenum/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait SetBit</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Output">Output</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>typenum</a>::<wbr><a href='index.html'>uint</a></p><script>window.sidebarCurrent = {name: 'SetBit', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/typenum/uint.rs.html#1111-1114' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>typenum</a>::<wbr><a href='index.html'>uint</a>::<wbr><a class="trait" href=''>SetBit</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait SetBit&lt;I, B&gt; {
type <a href='#associatedtype.Output' class="type">Output</a>;
}</pre></div><div class='docblock'><p>A <strong>type operator</strong> that, when implemented for unsigned integer <code>N</code>, sets the bit at position
<code>I</code> to <code>B</code>.</p>
</div>
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Output' class='method'><code id='Output.t'>type <a href='#associatedtype.Output' class="type">Output</a></code></h3></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-SetBit%3CI%2C%20B%3E' class='impl'><code class='in-band'>impl&lt;N, I, B&gt; SetBit&lt;I, B&gt; for N <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;N: PrivateSetBit&lt;I, B&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;PrivateSetBitOut&lt;N, I, B&gt;: Trim,&nbsp;</span></code><a href='#impl-SetBit%3CI%2C%20B%3E' class='anchor'></a><a class='srclink' href='../../src/typenum/uint.rs.html#1121-1127' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Output-1' class="type"><code id='Output.t-1'>type <a href='#associatedtype.Output-1' class="type">Output</a> = TrimOut&lt;PrivateSetBitOut&lt;N, I, B&gt;&gt;</code></h4></div></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/typenum/uint/trait.SetBit.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>&#9166;</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 = "typenum";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>

1
doc/typenum/uint/type.GetBitOut.html Normal file
View File

@@ -0,0 +1 @@
<!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 `GetBitOut` type in crate `typenum`."><meta name="keywords" content="rust, rustlang, rust-lang, GetBitOut"><title>typenum::uint::GetBitOut - 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 type"><!--[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">&#9776;</div><a href='../../typenum/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Type Definition GetBitOut</p><div class="sidebar-elems"><p class='location'><a href='../index.html'>typenum</a>::<wbr><a href='index.html'>uint</a></p><script>window.sidebarCurrent = {name: 'GetBitOut', ty: 'type', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/typenum/uint.rs.html#1072' title='goto source code'>[src]</a></span><span class='in-band'>Type Definition <a href='../index.html'>typenum</a>::<wbr><a href='index.html'>uint</a>::<wbr><a class="type" href=''>GetBitOut</a></span></h1><pre class='rust typedef'>type GetBitOut&lt;N, I&gt; = &lt;N as <a class="trait" href="../../typenum/uint/trait.GetBit.html" title="trait typenum::uint::GetBit">GetBit</a>&lt;I&gt;&gt;::<a class="type" href="../../typenum/uint/trait.GetBit.html#associatedtype.Output" title="type typenum::uint::GetBit::Output">Output</a>;</pre></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>&#9166;</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 = "typenum";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>

2
doc/typenum/uint/type.SetBitOut.html Normal file
View File

@@ -0,0 +1,2 @@
<!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 `SetBitOut` type in crate `typenum`."><meta name="keywords" content="rust, rustlang, rust-lang, SetBitOut"><title>typenum::uint::SetBitOut - 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 type"><!--[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">&#9776;</div><a href='../../typenum/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Type Definition SetBitOut</p><div class="sidebar-elems"><p class='location'><a href='../index.html'>typenum</a>::<wbr><a href='index.html'>uint</a></p><script>window.sidebarCurrent = {name: 'SetBitOut', ty: 'type', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/typenum/uint.rs.html#1116' title='goto source code'>[src]</a></span><span class='in-band'>Type Definition <a href='../index.html'>typenum</a>::<wbr><a href='index.html'>uint</a>::<wbr><a class="type" href=''>SetBitOut</a></span></h1><pre class='rust typedef'>type SetBitOut&lt;N, I, B&gt; = &lt;N as <a class="trait" href="../../typenum/uint/trait.SetBit.html" title="trait typenum::uint::SetBit">SetBit</a>&lt;I, B&gt;&gt;::<a class="type" href="../../typenum/uint/trait.SetBit.html#associatedtype.Output" title="type typenum::uint::SetBit::Output">Output</a>;</pre><div class='docblock'><p>Alias for the result of calling <code>SetBit</code>: <code>SetBitOut&lt;N, I, B&gt; = &lt;N as SetBit&lt;I, B&gt;&gt;::Output</code>.</p>
</div></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>&#9166;</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 = "typenum";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>