Files
phy/hexf_parse/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

15 lines
5.5 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="Parses hexadecimal float literals. There are two functions `parse_hexf32` and `parse_hexf64` provided for each type."><title>hexf_parse - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="hexf_parse" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../hexf_parse/index.html">hexf_<wbr>parse</a><span class="version">0.2.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>hexf_parse</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/hexf_parse/lib.rs.html#1-533">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parses hexadecimal float literals.
There are two functions <code>parse_hexf32</code> and <code>parse_hexf64</code> provided for each type.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hexf_parse::<span class="kw-2">*</span>;
<span class="macro">assert_eq!</span>(parse_hexf32(<span class="string">"0x1.99999ap-4"</span>, <span class="bool-val">false</span>), <span class="prelude-val">Ok</span>(<span class="number">0.1f32</span>));
<span class="macro">assert_eq!</span>(parse_hexf64(<span class="string">"0x1.999999999999ap-4"</span>, <span class="bool-val">false</span>), <span class="prelude-val">Ok</span>(<span class="number">0.1f64</span>));</code></pre></div>
<p>An additional <code>bool</code> parameter can be set to true if you want to allow underscores.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hexf_parse::<span class="kw-2">*</span>;
<span class="macro">assert!</span>(parse_hexf64(<span class="string">"0x0.1_7p8"</span>, <span class="bool-val">false</span>).is_err());
<span class="macro">assert_eq!</span>(parse_hexf64(<span class="string">"0x0.1_7p8"</span>, <span class="bool-val">true</span>), <span class="prelude-val">Ok</span>(<span class="number">23.0f64</span>));</code></pre></div>
<p>The error is reported via an opaque <code>ParseHexfError</code> type.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.ParseHexfError.html" title="struct hexf_parse::ParseHexfError">Parse<wbr>Hexf<wbr>Error</a></div><div class="desc docblock-short">An opaque error type from <code>parse_hexf32</code> and <code>parse_hexf64</code>.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.parse_hexf32.html" title="fn hexf_parse::parse_hexf32">parse_<wbr>hexf32</a></div><div class="desc docblock-short">Tries to parse a hexadecimal float literal to <code>f32</code>.
The underscore is allowed only when <code>allow_underscore</code> is true.</div></li><li><div class="item-name"><a class="fn" href="fn.parse_hexf64.html" title="fn hexf_parse::parse_hexf64">parse_<wbr>hexf64</a></div><div class="desc docblock-short">Tries to parse a hexadecimal float literal to <code>f64</code>.
The underscore is allowed only when <code>allow_underscore</code> is true.</div></li></ul></section></div></main></body></html>