16 lines
No EOL
6.9 KiB
HTML
16 lines
No EOL
6.9 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"><title>Finish in nom - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-fa3bb1812debf86c.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="nom" data-themes="" data-resource-suffix="" data-rustdoc-version="1.74.0 (79e9716c9 2023-11-13)" data-channel="1.74.0" data-search-js="search-8be46b629f5f14a8.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-c5bd66d33317d69f.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc 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="logo-container" href="../nom/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a></nav><nav class="sidebar"><a class="logo-container" href="../nom/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Finish</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.finish">finish</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In nom</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">nom</a>::<wbr><a class="trait" href="#">Finish</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/nom/internal.rs.html#21-33">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Finish<I, O, E> {
|
||
// Required method
|
||
fn <a href="#tymethod.finish" class="fn">finish</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.tuple.html">(I, O)</a>, E>;
|
||
}</code></pre><details class="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="toggle method-toggle" open><summary><section id="tymethod.finish" class="method"><a class="src rightside" href="../src/nom/internal.rs.html#32">source</a><h4 class="code-header">fn <a href="#tymethod.finish" class="fn">finish</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.74.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.74.0/std/primitive.tuple.html">(I, O)</a>, E></h4></section></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 id="implementors-list"><section id="impl-Finish%3CI,+O,+E%3E-for-IResult%3CI,+O,+E%3E" class="impl"><a class="src rightside" href="../src/nom/internal.rs.html#35-45">source</a><a href="#impl-Finish%3CI,+O,+E%3E-for-IResult%3CI,+O,+E%3E" class="anchor">§</a><h3 class="code-header">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 src="../implementors/nom/internal/trait.Finish.js" async></script></section></div></main></body></html> |