pumpkin/ramp/ll/base/index.html

148 lines
6.1 KiB
HTML
Raw Normal View History

2016-05-10 15:03:32 -04:00
<!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 `base` mod in crate `ramp`.">
<meta name="keywords" content="rust, rustlang, rust-lang, base">
<title>ramp::ll::base - Rust</title>
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../main.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'><a href='../../index.html'>ramp</a>::<wbr><a href='../index.html'>ll</a></p><script>window.sidebarCurrent = {name: 'base', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content mod">
<h1 class='fqn'><span class='in-band'>Module <a href='../../index.html'>ramp</a>::<wbr><a href='../index.html'>ll</a>::<wbr><a class='mod' href=''>base</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a id='src-622' class='srclink' href='../../../src/ramp/ll/base.rs.html#15-383' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Base conversion utilities</p>
<p>Provides functions for converting an integer to/from a given base. In both <code>to_base</code> and
<code>from_base</code> the base-N output or input (respectively) is stored as raw bytes. That means that a
base-10 input contains bytes each with a value from 0-9.</p>
</div><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class='fn' href='fn.base_digits_to_len.html'
title='ramp::ll::base::base_digits_to_len'>base_digits_to_len</a></td>
<td class='docblock short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class='fn' href='fn.from_base.html'
title='ramp::ll::base::from_base'>from_base</a></td>
<td class='docblock short'>
<p>Converts the base <code>base</code> bytestring {bp, bs}, storing the limbs in <code>out</code>. <code>out</code> is assumed to
have enough space to store the result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='fn' href='fn.num_base_digits.html'
title='ramp::ll::base::num_base_digits'>num_base_digits</a></td>
<td class='docblock short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class='fn' href='fn.to_base.html'
title='ramp::ll::base::to_base'>to_base</a></td>
<td class='docblock short'>
<p>Converts <code>nn</code> limbs at <code>np</code> to the given base, storing the output in <code>out</code>. <code>out</code> is assumed to
have enough space for the entire digit. The output is stored from most-significant digit to least.</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../";
window.currentCrate = "ramp";
window.playgroundUrl = "";
</script>
<script src="../../../jquery.js"></script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>