15 lines
7.2 KiB
HTML
15 lines
7.2 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="Helper trait to convert a parser’s result to a more manageable type"><meta name="keywords" content="rust, rustlang, rust-lang, Finish"><title>Finish in nom - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../nom/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../nom/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Finish</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.finish">finish</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In nom</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../nom/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">nom</a>::<wbr><a class="trait" href="#">Finish</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/nom/internal.rs.html#21-33">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait Finish<I, O, E> {
|
||
fn <a href="#tymethod.finish" class="fnname">finish</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.tuple.html">(I, O)</a>, E>;
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Helper trait to convert a parser’s result to a more manageable type</p>
|
||
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.finish" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/nom/internal.rs.html#32">source</a></div><h4 class="code-header">fn <a href="#tymethod.finish" class="fnname">finish</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.tuple.html">(I, O)</a>, E></h4></div></summary><div class="docblock"><p>converts the parser’s result to a type that is more consumable by error
|
||
management libraries. It keeps the same <code>Ok</code> branch, and merges <code>Err::Error</code>
|
||
and <code>Err::Failure</code> into the <code>Err</code> side.</p>
|
||
<p><em>warning</em>: if the result is <code>Err(Err::Incomplete(_))</code>, this method will panic.</p>
|
||
<ul>
|
||
<li>“complete” parsers: It will not be an issue, <code>Incomplete</code> is never used</li>
|
||
<li>“streaming” parsers: <code>Incomplete</code> will be returned if there’s not enough data
|
||
for the parser to decide, and you should gather more data before parsing again.
|
||
Once the parser returns either <code>Ok(_)</code>, <code>Err(Err::Error(_))</code> or <code>Err(Err::Failure(_))</code>,
|
||
you can get out of the parsing loop and call <code>finish()</code> on the parser’s result</li>
|
||
</ul>
|
||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><section id="impl-Finish%3CI%2C%20O%2C%20E%3E-for-IResult%3CI%2C%20O%2C%20E%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/nom/internal.rs.html#35-45">source</a></span><a href="#impl-Finish%3CI%2C%20O%2C%20E%3E-for-IResult%3CI%2C%20O%2C%20E%3E" class="anchor"></a><h3 class="code-header in-band">impl<I, O, E> <a class="trait" href="trait.Finish.html" title="trait nom::Finish">Finish</a><I, O, E> for <a class="type" href="type.IResult.html" title="type nom::IResult">IResult</a><I, O, E></h3></section></div><script type="text/javascript" src="../implementors/nom/internal/trait.Finish.js" data-ignore-extern-crates="" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="nom" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |