146 lines
80 KiB
HTML
146 lines
80 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="API documentation for the Rust `FromStr` trait in crate `nom`."><meta name="keywords" content="rust, rustlang, rust-lang, FromStr"><title>nom::lib::std::str::FromStr - 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 trait"><!--[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">☰</div><a href='../../../../nom/index.html'><div class='logo-container'><img src='../../../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait FromStr</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Err">Err</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.from_str">from_str</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-FromStr-for-IpAddr">IpAddr</a><a href="#impl-FromStr-for-Ipv4Addr">Ipv4Addr</a><a href="#impl-FromStr-for-Ipv6Addr">Ipv6Addr</a><a href="#impl-FromStr-for-NonZeroI128">NonZeroI128</a><a href="#impl-FromStr-for-NonZeroI16">NonZeroI16</a><a href="#impl-FromStr-for-NonZeroI32">NonZeroI32</a><a href="#impl-FromStr-for-NonZeroI64">NonZeroI64</a><a href="#impl-FromStr-for-NonZeroI8">NonZeroI8</a><a href="#impl-FromStr-for-NonZeroIsize">NonZeroIsize</a><a href="#impl-FromStr-for-NonZeroU128">NonZeroU128</a><a href="#impl-FromStr-for-NonZeroU16">NonZeroU16</a><a href="#impl-FromStr-for-NonZeroU32">NonZeroU32</a><a href="#impl-FromStr-for-NonZeroU64">NonZeroU64</a><a href="#impl-FromStr-for-NonZeroU8">NonZeroU8</a><a href="#impl-FromStr-for-NonZeroUsize">NonZeroUsize</a><a href="#impl-FromStr-for-PathBuf">PathBuf</a><a href="#impl-FromStr-for-SocketAddr">SocketAddr</a><a href="#impl-FromStr-for-SocketAddrV4">SocketAddrV4</a><a href="#impl-FromStr-for-SocketAddrV6">SocketAddrV6</a><a href="#impl-FromStr-for-bool">bool</a><a href="#impl-FromStr-for-char">char</a><a href="#impl-FromStr-for-f32">f32</a><a href="#impl-FromStr-for-f64">f64</a><a href="#impl-FromStr-for-i128">i128</a><a href="#impl-FromStr-for-i16">i16</a><a href="#impl-FromStr-for-i32">i32</a><a href="#impl-FromStr-for-i64">i64</a><a href="#impl-FromStr-for-i8">i8</a><a href="#impl-FromStr-for-isize">isize</a><a href="#impl-FromStr-for-u128">u128</a><a href="#impl-FromStr-for-u16">u16</a><a href="#impl-FromStr-for-u32">u32</a><a href="#impl-FromStr-for-u64">u64</a><a href="#impl-FromStr-for-u8">u8</a><a href="#impl-FromStr-for-usize">usize</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../../index.html'>nom</a>::<wbr><a href='../../index.html'>lib</a>::<wbr><a href='../index.html'>std</a>::<wbr><a href='index.html'>str</a></p><script>window.sidebarCurrent = {name: 'FromStr', ty: 'trait', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled 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 class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#76-106' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../../index.html'>nom</a>::<wbr><a href='../../index.html'>lib</a>::<wbr><a href='../index.html'>std</a>::<wbr><a href='index.html'>str</a>::<wbr><a class="trait" href=''>FromStr</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait FromStr {
|
||
type <a href='#associatedtype.Err' class="type">Err</a>;
|
||
fn <a href='#tymethod.from_str' class='fnname'>from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><Self, Self::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>>;
|
||
}</pre></div><div class='docblock'><p>Parse a value from a string</p>
|
||
<p><code>FromStr</code>'s <a href="#tymethod.from_str"><code>from_str</code></a> method is often used implicitly, through
|
||
<a href="../../std/primitive.str.html"><code>str</code></a>'s <a href="../../std/primitive.str.html#method.parse"><code>parse</code></a> method. See <a href="../../std/primitive.str.html#method.parse"><code>parse</code></a>'s documentation for examples.</p>
|
||
<p><code>FromStr</code> does not have a lifetime parameter, and so you can only parse types
|
||
that do not contain a lifetime parameter themselves. In other words, you can
|
||
parse an <code>i32</code> with <code>FromStr</code>, but not a <code>&i32</code>. You can parse a struct that
|
||
contains an <code>i32</code>, but not one that contains an <code>&i32</code>.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<p>Basic implementation of <code>FromStr</code> on an example <code>Point</code> type:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">str</span>::<span class="ident">FromStr</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">num</span>::<span class="ident">ParseIntError</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">PartialEq</span>)]</span>
|
||
<span class="kw">struct</span> <span class="ident">Point</span> {
|
||
<span class="ident">x</span>: <span class="ident">i32</span>,
|
||
<span class="ident">y</span>: <span class="ident">i32</span>
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">FromStr</span> <span class="kw">for</span> <span class="ident">Point</span> {
|
||
<span class="kw">type</span> <span class="prelude-val">Err</span> <span class="op">=</span> <span class="ident">ParseIntError</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">from_str</span>(<span class="ident">s</span>: <span class="kw-2">&</span><span class="ident">str</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="self">Self</span>::<span class="prelude-val">Err</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">coords</span>: <span class="ident">Vec</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> <span class="op">=</span> <span class="ident">s</span>.<span class="ident">trim_matches</span>(<span class="op">|</span><span class="ident">p</span><span class="op">|</span> <span class="ident">p</span> <span class="op">=</span><span class="op">=</span> <span class="string">'('</span> <span class="op">|</span><span class="op">|</span> <span class="ident">p</span> <span class="op">=</span><span class="op">=</span> <span class="string">')'</span> )
|
||
.<span class="ident">split</span>(<span class="string">','</span>)
|
||
.<span class="ident">collect</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">x_fromstr</span> <span class="op">=</span> <span class="ident">coords</span>[<span class="number">0</span>].<span class="ident">parse</span>::<span class="op"><</span><span class="ident">i32</span><span class="op">></span>()<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> <span class="ident">y_fromstr</span> <span class="op">=</span> <span class="ident">coords</span>[<span class="number">1</span>].<span class="ident">parse</span>::<span class="op"><</span><span class="ident">i32</span><span class="op">></span>()<span class="question-mark">?</span>;
|
||
|
||
<span class="prelude-val">Ok</span>(<span class="ident">Point</span> { <span class="ident">x</span>: <span class="ident">x_fromstr</span>, <span class="ident">y</span>: <span class="ident">y_fromstr</span> })
|
||
}
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">p</span> <span class="op">=</span> <span class="ident">Point</span>::<span class="ident">from_str</span>(<span class="string">"(1,2)"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">p</span>.<span class="ident">unwrap</span>(), <span class="ident">Point</span>{ <span class="ident">x</span>: <span class="number">1</span>, <span class="ident">y</span>: <span class="number">2</span>} )</pre></div>
|
||
</div>
|
||
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Err' class='method'><code id='Err.t'>type <a href='#associatedtype.Err' class="type">Err</a></code></h3><div class='docblock'><p>The associated error which can be returned from parsing.</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.from_str' class='method'><code id='from_str.v'>fn <a href='#tymethod.from_str' class='fnname'>from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><Self, Self::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code></h3><div class='docblock'><p>Parses a string <code>s</code> to return a value of this type.</p>
|
||
<p>If parsing succeeds, return the value inside <a href="../../std/result/enum.Result.html#variant.Ok"><code>Ok</code></a>, otherwise
|
||
when the string is ill-formatted return an error specific to the
|
||
inside <a href="../../std/result/enum.Result.html#variant.Err"><code>Err</code></a>. The error type is specific to implementation of the trait.</p>
|
||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
<p>Basic usage with <a href="../../std/primitive.i32.html"><code>i32</code></a>, a type that implements <code>FromStr</code>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">str</span>::<span class="ident">FromStr</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="string">"5"</span>;
|
||
<span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="ident">i32</span>::<span class="ident">from_str</span>(<span class="ident">s</span>).<span class="ident">unwrap</span>();
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">5</span>, <span class="ident">x</span>);</pre></div>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-FromStr-for-SocketAddrV6' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/addr/struct.SocketAddrV6.html" title="struct std::net::addr::SocketAddrV6">SocketAddrV6</a></code><a href='#impl-FromStr-for-SocketAddrV6' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/net/parser.rs.html#307-315' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-1' class="type"><code id='Err.t-1'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/parser/struct.AddrParseError.html" title="struct std::net::parser::AddrParseError">AddrParseError</a></code></h4><h4 id='method.from_str' class="method hidden"><code id='from_str.v-1'>fn <a href='#method.from_str' class='fnname'>from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/addr/struct.SocketAddrV6.html" title="struct std::net::addr::SocketAddrV6">SocketAddrV6</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/parser/struct.AddrParseError.html" title="struct std::net::parser::AddrParseError">AddrParseError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/net/parser.rs.html#309-314' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-PathBuf' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a></code><a href='#impl-FromStr-for-PathBuf' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/path.rs.html#1505-1511' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-2' class="type"><code id='Err.t-2'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="enum" href="../../../../nom/lib/std/convert/enum.Infallible.html" title="enum nom::lib::std::convert::Infallible">Infallible</a></code></h4><h4 id='method.from_str-1' class="method hidden"><code id='from_str.v-2'>fn <a href='#method.from_str' class='fnname'>from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a>, <<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/path.rs.html#1508-1510' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-Ipv4Addr' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a></code><a href='#impl-FromStr-for-Ipv4Addr' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/net/parser.rs.html#274-282' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-3' class="type"><code id='Err.t-3'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/parser/struct.AddrParseError.html" title="struct std::net::parser::AddrParseError">AddrParseError</a></code></h4><h4 id='method.from_str-2' class="method hidden"><code id='from_str.v-3'>fn <a href='#method.from_str' class='fnname'>from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/parser/struct.AddrParseError.html" title="struct std::net::parser::AddrParseError">AddrParseError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/net/parser.rs.html#276-281' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-IpAddr' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="enum" href="https://doc.rust-lang.org/nightly/std/net/ip/enum.IpAddr.html" title="enum std::net::ip::IpAddr">IpAddr</a></code><a href='#impl-FromStr-for-IpAddr' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/net/parser.rs.html#263-271' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-4' class="type"><code id='Err.t-4'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/parser/struct.AddrParseError.html" title="struct std::net::parser::AddrParseError">AddrParseError</a></code></h4><h4 id='method.from_str-3' class="method hidden"><code id='from_str.v-4'>fn <a href='#method.from_str' class='fnname'>from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/std/net/ip/enum.IpAddr.html" title="enum std::net::ip::IpAddr">IpAddr</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/parser/struct.AddrParseError.html" title="struct std::net::parser::AddrParseError">AddrParseError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/net/parser.rs.html#265-270' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-SocketAddrV4' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/addr/struct.SocketAddrV4.html" title="struct std::net::addr::SocketAddrV4">SocketAddrV4</a></code><a href='#impl-FromStr-for-SocketAddrV4' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/net/parser.rs.html#296-304' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-5' class="type"><code id='Err.t-5'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/parser/struct.AddrParseError.html" title="struct std::net::parser::AddrParseError">AddrParseError</a></code></h4><h4 id='method.from_str-4' class="method hidden"><code id='from_str.v-5'>fn <a href='#method.from_str' class='fnname'>from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/addr/struct.SocketAddrV4.html" title="struct std::net::addr::SocketAddrV4">SocketAddrV4</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/parser/struct.AddrParseError.html" title="struct std::net::parser::AddrParseError">AddrParseError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/net/parser.rs.html#298-303' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-SocketAddr' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a></code><a href='#impl-FromStr-for-SocketAddr' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/net/parser.rs.html#318-326' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-6' class="type"><code id='Err.t-6'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/parser/struct.AddrParseError.html" title="struct std::net::parser::AddrParseError">AddrParseError</a></code></h4><h4 id='method.from_str-5' class="method hidden"><code id='from_str.v-6'>fn <a href='#method.from_str' class='fnname'>from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/parser/struct.AddrParseError.html" title="struct std::net::parser::AddrParseError">AddrParseError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/net/parser.rs.html#320-325' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-Ipv6Addr' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv6Addr.html" title="struct std::net::ip::Ipv6Addr">Ipv6Addr</a></code><a href='#impl-FromStr-for-Ipv6Addr' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/net/parser.rs.html#285-293' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-7' class="type"><code id='Err.t-7'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/parser/struct.AddrParseError.html" title="struct std::net::parser::AddrParseError">AddrParseError</a></code></h4><h4 id='method.from_str-6' class="method hidden"><code id='from_str.v-7'>fn <a href='#method.from_str' class='fnname'>from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv6Addr.html" title="struct std::net::ip::Ipv6Addr">Ipv6Addr</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/parser/struct.AddrParseError.html" title="struct std::net::parser::AddrParseError">AddrParseError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/net/parser.rs.html#287-292' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-NonZeroI16' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI16.html" title="struct core::num::NonZeroI16">NonZeroI16</a></code><a href='#impl-FromStr-for-NonZeroI16' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#138-146' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-8' class="type"><code id='Err.t-8'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-7' class="method hidden"><code id='from_str.v-8'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI16.html" title="struct core::num::NonZeroI16">NonZeroI16</a>, <<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI16.html" title="struct core::num::NonZeroI16">NonZeroI16</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#140-145' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-u16' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code><a href='#impl-FromStr-for-u16' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4914-4919' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-9' class="type"><code id='Err.t-9'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-8' class="method hidden"><code id='from_str.v-9'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4916-4918' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-char' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a></code><a href='#impl-FromStr-for-char' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/char/convert.rs.html#197-209' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-10' class="type"><code id='Err.t-10'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/char/convert/struct.ParseCharError.html" title="struct core::char::convert::ParseCharError">ParseCharError</a></code></h4><h4 id='method.from_str-9' class="method hidden"><code id='from_str.v-10'>fn <a href='#method.from_str' class='fnname'>from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>, <<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/char/convert.rs.html#201-208' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-NonZeroU16' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU16.html" title="struct core::num::NonZeroU16">NonZeroU16</a></code><a href='#impl-FromStr-for-NonZeroU16' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#138-146' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-11' class="type"><code id='Err.t-11'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-10' class="method hidden"><code id='from_str.v-11'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU16.html" title="struct core::num::NonZeroU16">NonZeroU16</a>, <<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU16.html" title="struct core::num::NonZeroU16">NonZeroU16</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#140-145' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-i64' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code><a href='#impl-FromStr-for-i64' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4914-4919' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-12' class="type"><code id='Err.t-12'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-11' class="method hidden"><code id='from_str.v-12'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4916-4918' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-usize' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a href='#impl-FromStr-for-usize' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4914-4919' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-13' class="type"><code id='Err.t-13'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-12' class="method hidden"><code id='from_str.v-13'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4916-4918' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-NonZeroI32' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI32.html" title="struct core::num::NonZeroI32">NonZeroI32</a></code><a href='#impl-FromStr-for-NonZeroI32' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#138-146' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-14' class="type"><code id='Err.t-14'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-13' class="method hidden"><code id='from_str.v-14'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI32.html" title="struct core::num::NonZeroI32">NonZeroI32</a>, <<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI32.html" title="struct core::num::NonZeroI32">NonZeroI32</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#140-145' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-i32' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code><a href='#impl-FromStr-for-i32' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4914-4919' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-15' class="type"><code id='Err.t-15'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-14' class="method hidden"><code id='from_str.v-15'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4916-4918' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-NonZeroUsize' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroUsize.html" title="struct core::num::NonZeroUsize">NonZeroUsize</a></code><a href='#impl-FromStr-for-NonZeroUsize' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#138-146' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-16' class="type"><code id='Err.t-16'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-15' class="method hidden"><code id='from_str.v-16'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroUsize.html" title="struct core::num::NonZeroUsize">NonZeroUsize</a>, <<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroUsize.html" title="struct core::num::NonZeroUsize">NonZeroUsize</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#140-145' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-f32' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a href='#impl-FromStr-for-f32' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/dec2flt/mod.rs.html#104-159' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-17' class="type"><code id='Err.t-17'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/dec2flt/struct.ParseFloatError.html" title="struct core::num::dec2flt::ParseFloatError">ParseFloatError</a></code></h4><h4 id='method.from_str-16' class="method"><code id='from_str.v-17'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/dec2flt/struct.ParseFloatError.html" title="struct core::num::dec2flt::ParseFloatError">ParseFloatError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/dec2flt/mod.rs.html#156-158' title='goto source code'>[src]</a></h4><div class='docblock'><p>Converts a string in base 10 to a float.
|
||
Accepts an optional decimal exponent.</p>
|
||
<p>This function accepts strings such as</p>
|
||
<ul>
|
||
<li>'3.14'</li>
|
||
<li>'-3.14'</li>
|
||
<li>'2.5E10', or equivalently, '2.5e10'</li>
|
||
<li>'2.5E-10'</li>
|
||
<li>'5.'</li>
|
||
<li>'.5', or, equivalently, '0.5'</li>
|
||
<li>'inf', '-inf', 'NaN'</li>
|
||
</ul>
|
||
<p>Leading and trailing whitespace represent an error.</p>
|
||
<h1 id="grammar" class="section-header"><a href="#grammar">Grammar</a></h1>
|
||
<p>All strings that adhere to the following <a href="https://www.w3.org/TR/REC-xml/#sec-notation">EBNF</a> grammar
|
||
will result in an [<code>Ok</code>] being returned:</p>
|
||
<pre><code class="language-txt">Float ::= Sign? ( 'inf' | 'NaN' | Number )
|
||
Number ::= ( Digit+ |
|
||
Digit+ '.' Digit* |
|
||
Digit* '.' Digit+ ) Exp?
|
||
Exp ::= [eE] Sign? Digit+
|
||
Sign ::= [+-]
|
||
Digit ::= [0-9]
|
||
</code></pre>
|
||
<h1 id="known-bugs" class="section-header"><a href="#known-bugs">Known bugs</a></h1>
|
||
<p>In some situations, some strings that should create a valid float
|
||
instead return an error. See <a href="https://github.com/rust-lang/rust/issues/31407">issue #31407</a> for details.</p>
|
||
<h1 id="arguments" class="section-header"><a href="#arguments">Arguments</a></h1>
|
||
<ul>
|
||
<li>src - A string</li>
|
||
</ul>
|
||
<h1 id="return-value" class="section-header"><a href="#return-value">Return value</a></h1>
|
||
<p><code>Err(ParseFloatError)</code> if the string did not represent a valid
|
||
number. Otherwise, <code>Ok(n)</code> where <code>n</code> is the floating-point
|
||
number represented by <code>src</code>.</p>
|
||
</div></div><h3 id='impl-FromStr-for-bool' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a href='#impl-FromStr-for-bool' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#109-142' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-18' class="type"><code id='Err.t-18'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="../../../../nom/lib/std/str/struct.ParseBoolError.html" title="struct nom::lib::std::str::ParseBoolError">ParseBoolError</a></code></h4><h4 id='method.from_str-17' class="method"><code id='from_str.v-18'>fn <a href='#method.from_str' class='fnname'>from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <a class="struct" href="../../../../nom/lib/std/str/struct.ParseBoolError.html" title="struct nom::lib::std::str::ParseBoolError">ParseBoolError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#135-141' title='goto source code'>[src]</a></h4><div class='docblock'><p>Parse a <code>bool</code> from a string.</p>
|
||
<p>Yields a <code>Result<bool, ParseBoolError></code>, because <code>s</code> may or may not
|
||
actually be parseable.</p>
|
||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</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">str</span>::<span class="ident">FromStr</span>;
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">FromStr</span>::<span class="ident">from_str</span>(<span class="string">"true"</span>), <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">FromStr</span>::<span class="ident">from_str</span>(<span class="string">"false"</span>), <span class="prelude-val">Ok</span>(<span class="bool-val">false</span>));
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="op"><</span><span class="ident">bool</span> <span class="kw">as</span> <span class="ident">FromStr</span><span class="op">></span>::<span class="ident">from_str</span>(<span class="string">"not even a boolean"</span>).<span class="ident">is_err</span>());</pre></div>
|
||
<p>Note, in many cases, the <code>.parse()</code> method on <code>str</code> is more proper.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">"true"</span>.<span class="ident">parse</span>(), <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">"false"</span>.<span class="ident">parse</span>(), <span class="prelude-val">Ok</span>(<span class="bool-val">false</span>));
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="string">"not even a boolean"</span>.<span class="ident">parse</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>().<span class="ident">is_err</span>());</pre></div>
|
||
</div></div><h3 id='impl-FromStr-for-i8' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code><a href='#impl-FromStr-for-i8' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4914-4919' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-19' class="type"><code id='Err.t-19'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-18' class="method hidden"><code id='from_str.v-19'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4916-4918' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-NonZeroI128' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI128.html" title="struct core::num::NonZeroI128">NonZeroI128</a></code><a href='#impl-FromStr-for-NonZeroI128' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#138-146' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-20' class="type"><code id='Err.t-20'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-19' class="method hidden"><code id='from_str.v-20'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI128.html" title="struct core::num::NonZeroI128">NonZeroI128</a>, <<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI128.html" title="struct core::num::NonZeroI128">NonZeroI128</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#140-145' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-i128' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i128.html">i128</a></code><a href='#impl-FromStr-for-i128' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4914-4919' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-21' class="type"><code id='Err.t-21'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-20' class="method hidden"><code id='from_str.v-21'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i128.html">i128</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4916-4918' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-NonZeroI8' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI8.html" title="struct core::num::NonZeroI8">NonZeroI8</a></code><a href='#impl-FromStr-for-NonZeroI8' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#138-146' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-22' class="type"><code id='Err.t-22'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-21' class="method hidden"><code id='from_str.v-22'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI8.html" title="struct core::num::NonZeroI8">NonZeroI8</a>, <<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI8.html" title="struct core::num::NonZeroI8">NonZeroI8</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#140-145' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-u32' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a href='#impl-FromStr-for-u32' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4914-4919' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-23' class="type"><code id='Err.t-23'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-22' class="method hidden"><code id='from_str.v-23'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4916-4918' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-isize' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></code><a href='#impl-FromStr-for-isize' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4914-4919' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-24' class="type"><code id='Err.t-24'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-23' class="method hidden"><code id='from_str.v-24'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4916-4918' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-u64' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code><a href='#impl-FromStr-for-u64' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4914-4919' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-25' class="type"><code id='Err.t-25'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-24' class="method hidden"><code id='from_str.v-25'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4916-4918' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-u128' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u128.html">u128</a></code><a href='#impl-FromStr-for-u128' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4914-4919' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-26' class="type"><code id='Err.t-26'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-25' class="method hidden"><code id='from_str.v-26'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u128.html">u128</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4916-4918' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-i16' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></code><a href='#impl-FromStr-for-i16' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4914-4919' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-27' class="type"><code id='Err.t-27'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-26' class="method hidden"><code id='from_str.v-27'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4916-4918' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-NonZeroI64' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI64.html" title="struct core::num::NonZeroI64">NonZeroI64</a></code><a href='#impl-FromStr-for-NonZeroI64' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#138-146' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-28' class="type"><code id='Err.t-28'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-27' class="method hidden"><code id='from_str.v-28'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI64.html" title="struct core::num::NonZeroI64">NonZeroI64</a>, <<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI64.html" title="struct core::num::NonZeroI64">NonZeroI64</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#140-145' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-NonZeroU8' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU8.html" title="struct core::num::NonZeroU8">NonZeroU8</a></code><a href='#impl-FromStr-for-NonZeroU8' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#138-146' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-29' class="type"><code id='Err.t-29'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-28' class="method hidden"><code id='from_str.v-29'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU8.html" title="struct core::num::NonZeroU8">NonZeroU8</a>, <<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU8.html" title="struct core::num::NonZeroU8">NonZeroU8</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#140-145' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-u8' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a href='#impl-FromStr-for-u8' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4914-4919' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-30' class="type"><code id='Err.t-30'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-29' class="method hidden"><code id='from_str.v-30'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#4916-4918' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-NonZeroU64' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU64.html" title="struct core::num::NonZeroU64">NonZeroU64</a></code><a href='#impl-FromStr-for-NonZeroU64' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#138-146' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-31' class="type"><code id='Err.t-31'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-30' class="method hidden"><code id='from_str.v-31'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU64.html" title="struct core::num::NonZeroU64">NonZeroU64</a>, <<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU64.html" title="struct core::num::NonZeroU64">NonZeroU64</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#140-145' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-NonZeroU128' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU128.html" title="struct core::num::NonZeroU128">NonZeroU128</a></code><a href='#impl-FromStr-for-NonZeroU128' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#138-146' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-32' class="type"><code id='Err.t-32'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-31' class="method hidden"><code id='from_str.v-32'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU128.html" title="struct core::num::NonZeroU128">NonZeroU128</a>, <<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU128.html" title="struct core::num::NonZeroU128">NonZeroU128</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#140-145' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-NonZeroIsize' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroIsize.html" title="struct core::num::NonZeroIsize">NonZeroIsize</a></code><a href='#impl-FromStr-for-NonZeroIsize' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#138-146' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-33' class="type"><code id='Err.t-33'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-32' class="method hidden"><code id='from_str.v-33'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroIsize.html" title="struct core::num::NonZeroIsize">NonZeroIsize</a>, <<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroIsize.html" title="struct core::num::NonZeroIsize">NonZeroIsize</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#140-145' title='goto source code'>[src]</a></h4></div><h3 id='impl-FromStr-for-f64' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code><a href='#impl-FromStr-for-f64' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/dec2flt/mod.rs.html#104-159' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-34' class="type"><code id='Err.t-34'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/dec2flt/struct.ParseFloatError.html" title="struct core::num::dec2flt::ParseFloatError">ParseFloatError</a></code></h4><h4 id='method.from_str-33' class="method"><code id='from_str.v-34'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/dec2flt/struct.ParseFloatError.html" title="struct core::num::dec2flt::ParseFloatError">ParseFloatError</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/dec2flt/mod.rs.html#156-158' title='goto source code'>[src]</a></h4><div class='docblock'><p>Converts a string in base 10 to a float.
|
||
Accepts an optional decimal exponent.</p>
|
||
<p>This function accepts strings such as</p>
|
||
<ul>
|
||
<li>'3.14'</li>
|
||
<li>'-3.14'</li>
|
||
<li>'2.5E10', or equivalently, '2.5e10'</li>
|
||
<li>'2.5E-10'</li>
|
||
<li>'5.'</li>
|
||
<li>'.5', or, equivalently, '0.5'</li>
|
||
<li>'inf', '-inf', 'NaN'</li>
|
||
</ul>
|
||
<p>Leading and trailing whitespace represent an error.</p>
|
||
<h1 id="grammar-1" class="section-header"><a href="#grammar-1">Grammar</a></h1>
|
||
<p>All strings that adhere to the following <a href="https://www.w3.org/TR/REC-xml/#sec-notation">EBNF</a> grammar
|
||
will result in an [<code>Ok</code>] being returned:</p>
|
||
<pre><code class="language-txt">Float ::= Sign? ( 'inf' | 'NaN' | Number )
|
||
Number ::= ( Digit+ |
|
||
Digit+ '.' Digit* |
|
||
Digit* '.' Digit+ ) Exp?
|
||
Exp ::= [eE] Sign? Digit+
|
||
Sign ::= [+-]
|
||
Digit ::= [0-9]
|
||
</code></pre>
|
||
<h1 id="known-bugs-1" class="section-header"><a href="#known-bugs-1">Known bugs</a></h1>
|
||
<p>In some situations, some strings that should create a valid float
|
||
instead return an error. See <a href="https://github.com/rust-lang/rust/issues/31407">issue #31407</a> for details.</p>
|
||
<h1 id="arguments-1" class="section-header"><a href="#arguments-1">Arguments</a></h1>
|
||
<ul>
|
||
<li>src - A string</li>
|
||
</ul>
|
||
<h1 id="return-value-1" class="section-header"><a href="#return-value-1">Return value</a></h1>
|
||
<p><code>Err(ParseFloatError)</code> if the string did not represent a valid
|
||
number. Otherwise, <code>Ok(n)</code> where <code>n</code> is the floating-point
|
||
number represented by <code>src</code>.</p>
|
||
</div></div><h3 id='impl-FromStr-for-NonZeroU32' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU32.html" title="struct core::num::NonZeroU32">NonZeroU32</a></code><a href='#impl-FromStr-for-NonZeroU32' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#138-146' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-35' class="type"><code id='Err.t-35'>type <a href='#associatedtype.Err' class="type">Err</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.ParseIntError.html" title="struct core::num::ParseIntError">ParseIntError</a></code></h4><h4 id='method.from_str-34' class="method hidden"><code id='from_str.v-35'>fn <a href='#method.from_str' class='fnname'>from_str</a>(src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU32.html" title="struct core::num::NonZeroU32">NonZeroU32</a>, <<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU32.html" title="struct core::num::NonZeroU32">NonZeroU32</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/num/mod.rs.html#140-145' title='goto source code'>[src]</a></h4></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-FromStr' class='impl'><code class='in-band'>impl FromStr for <a class="struct" href="../../../../nom/lib/std/prelude/v1/v1/struct.String.html" title="struct nom::lib::std::prelude::v1::v1::String">String</a></code><a href='#impl-FromStr' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2118-2124' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Err-36' class="type"><code id='Err.t-36'>type <a href='#associatedtype.Err-36' class="type">Err</a> = <a class="enum" href="../../../../nom/lib/std/convert/enum.Infallible.html" title="enum nom::lib::std::convert::Infallible">Infallible</a></code></h4><h4 id='method.from_str-35' class="method hidden"><code id='from_str.v-36'>fn <a href='#method.from_str-35' class='fnname'>from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="../../../../nom/lib/std/prelude/v1/v1/enum.Result.html" title="enum nom::lib::std::prelude::v1::v1::Result">Result</a><<a class="struct" href="../../../../nom/lib/std/prelude/v1/v1/struct.String.html" title="struct nom::lib::std::prelude::v1::v1::String">String</a>, <<a class="struct" href="../../../../nom/lib/std/prelude/v1/v1/struct.String.html" title="struct nom::lib::std::prelude::v1::v1::String">String</a> as <a class="trait" href="../../../../nom/lib/std/str/trait.FromStr.html" title="trait nom::lib::std::str::FromStr">FromStr</a>>::<a class="type" href="../../../../nom/lib/std/str/trait.FromStr.html#associatedtype.Err" title="type nom::lib::std::str::FromStr::Err">Err</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2121-2123' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript" src="../../../../implementors/core/str/trait.FromStr.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../../../";window.currentCrate = "nom";</script><script src="../../../../aliases.js"></script><script src="../../../../main.js"></script><script defer src="../../../../search-index.js"></script></body></html> |