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

26
doc/typenum/int/index.html Normal file
View File

@@ -0,0 +1,26 @@
<!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 `int` mod in crate `typenum`."><meta name="keywords" content="rust, rustlang, rust-lang, int"><title>typenum::int - 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 int</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></ul></div><p class='location'><a href='../index.html'>typenum</a></p><script>window.sidebarCurrent = {name: 'int', 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/int.rs.html#1-935' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>typenum</a>::<wbr><a class="mod" href=''>int</a></span></h1><div class='docblock'><p>Type-level signed integers.</p>
<p>Type <strong>operators</strong> implemented:</p>
<p>From <code>core::ops</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>
<p>Note that operators that work on the underlying structure of the number are
intentionally not implemented. This is because this implementation of signed integers
does <em>not</em> use twos-complement, and implementing them would require making arbitrary
choices, causing the results of such operators to be difficult to reason about.</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">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">Integer</span>, <span class="ident">N3</span>, <span class="ident">P2</span>};
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">N3</span> <span class="kw">as</span> <span class="ident">Add</span><span class="op">&lt;</span><span class="ident">P2</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_i32</span>(), <span class="op">-</span><span class="number">1</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">N3</span> <span class="kw">as</span> <span class="ident">Sub</span><span class="op">&lt;</span><span class="ident">P2</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_i32</span>(), <span class="op">-</span><span class="number">5</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">N3</span> <span class="kw">as</span> <span class="ident">Mul</span><span class="op">&lt;</span><span class="ident">P2</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_i32</span>(), <span class="op">-</span><span class="number">6</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">N3</span> <span class="kw">as</span> <span class="ident">Div</span><span class="op">&lt;</span><span class="ident">P2</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_i32</span>(), <span class="op">-</span><span class="number">1</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="op">&lt;</span><span class="ident">N3</span> <span class="kw">as</span> <span class="ident">Rem</span><span class="op">&lt;</span><span class="ident">P2</span><span class="op">&gt;</span><span class="op">&gt;</span>::<span class="ident">Output</span>::<span class="ident">to_i32</span>(), <span class="op">-</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.Integer.html" title="trait typenum::marker_traits::Integer">Integer</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.NInt.html" title='typenum::int::NInt struct'>NInt</a></td><td class='docblock-short'><p>Type-level signed integers with negative sign.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.PInt.html" title='typenum::int::PInt struct'>PInt</a></td><td class='docblock-short'><p>Type-level signed integers with positive sign.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Z0.html" title='typenum::int::Z0 struct'>Z0</a></td><td class='docblock-short'><p>The type-level signed integer 0.</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/int/sidebar-items.js Normal file
View File

@@ -0,0 +1 @@
initSidebarItems({"struct":[["NInt","Type-level signed integers with negative sign."],["PInt","Type-level signed integers with positive sign."],["Z0","The type-level signed integer 0."]]});

162
doc/typenum/int/struct.NInt.html Normal file
View File

File diff suppressed because one or more lines are too long

180
doc/typenum/int/struct.PInt.html Normal file
View File

File diff suppressed because one or more lines are too long

167
doc/typenum/int/struct.Z0.html Normal file
View File

File diff suppressed because one or more lines are too long