25 lines
6.7 KiB
HTML
25 lines
6.7 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="Parse float from extracted float components."><meta name="keywords" content="rust, rustlang, rust-lang, parse_float"><title>parse_float in minimal_lexical - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc fn"><!--[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><a class="sidebar-logo" href="../minimal_lexical/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../minimal_lexical/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In minimal_lexical</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../minimal_lexical/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="index.html">minimal_lexical</a>::<wbr><a class="fn" href="#">parse_float</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/minimal_lexical/parse.rs.html#146-171">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn parse_float<'a, F, Iter1, Iter2>(<br> integer: Iter1,<br> fraction: Iter2,<br> exponent: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i32.html">i32</a><br>) -> F <span class="where fmt-newline">where<br> F: <a class="trait" href="trait.Float.html" title="trait minimal_lexical::Float">Float</a>,<br> Iter1: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = &'a <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> Iter2: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = &'a <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parse float from extracted float components.</p>
|
||
<ul>
|
||
<li><code>integer</code> - Cloneable, forward iterator over integer digits.</li>
|
||
<li><code>fraction</code> - Cloneable, forward iterator over integer digits.</li>
|
||
<li><code>exponent</code> - Parsed, 32-bit exponent.</li>
|
||
</ul>
|
||
<h2 id="preconditions"><a href="#preconditions">Preconditions</a></h2>
|
||
<ol>
|
||
<li>The integer should not have leading zeros.</li>
|
||
<li>The fraction should not have trailing zeros.</li>
|
||
<li>All bytes in <code>integer</code> and <code>fraction</code> should be valid digits,
|
||
in the range [`b’0’, b’9’].</li>
|
||
</ol>
|
||
<h2 id="panics"><a href="#panics">Panics</a></h2>
|
||
<p>Although passing garbage input will not cause memory safety issues,
|
||
it is very likely to cause a panic with a large number of digits, or
|
||
in debug mode. The big-integer arithmetic without the <code>alloc</code> feature
|
||
assumes a maximum, fixed-width input, which assumes at maximum a
|
||
value of <code>10^(769 + 342)</code>, or ~4000 bits of storage. Passing in
|
||
nonsensical digits may require up to ~6000 bits of storage, which will
|
||
panic when attempting to add it to the big integer. It is therefore
|
||
up to the caller to validate this input.</p>
|
||
<p>We cannot efficiently remove trailing zeros while only accepting a
|
||
forward iterator.</p>
|
||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="minimal_lexical" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |