|
|
<!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."><title>parse_float in minimal_lexical - 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="minimal_lexical" 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 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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../minimal_lexical/index.html">minimal_lexical</a><span class="version">0.2.1</span></h2></div><div class="sidebar-elems"></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="../minimal_lexical/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>Function <a href="index.html">minimal_lexical</a>::<wbr><a class="fn" href="#">parse_float</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/minimal_lexical/parse.rs.html#146-171">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn parse_float<'a, F, Iter1, Iter2>(
|
|
|
integer: Iter1,
|
|
|
fraction: Iter2,
|
|
|
exponent: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i32.html">i32</a>
|
|
|
) -> F<div class="where">where
|
|
|
F: <a class="trait" href="trait.Float.html" title="trait minimal_lexical::Float">Float</a>,
|
|
|
Iter1: <a class="trait" href="https://doc.rust-lang.org/1.76.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.76.0/std/primitive.u8.html">u8</a>> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
|
|
|
Iter2: <a class="trait" href="https://doc.rust-lang.org/1.76.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.76.0/std/primitive.u8.html">u8</a>> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></code></pre><details class="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></body></html> |