|
|
<!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="Error management"><title>nom::error - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="nom" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../nom/index.html">nom</a><span class="version">7.1.3</span></h2></div><h2 class="location"><a href="#">Module error</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate nom</a></h2></div></nav><div class="sidebar-resizer"></div>
|
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../nom/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">nom</a>::<wbr><a class="mod" href="#">error</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/error.rs.html#1-619">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Error management</p>
|
|
|
<p>Parsers are generic over their error type, requiring that it implements
|
|
|
the <code>error::ParseError<Input></code> trait.</p>
|
|
|
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Error.html" title="struct nom::error::Error">Error</a></div><div class="desc docblock-short">default error type, only contains the error’ location and code</div></li><li><div class="item-name"><a class="struct" href="struct.VerboseError.html" title="struct nom::error::VerboseError">VerboseError</a></div><div class="desc docblock-short">This error type accumulates errors and their position when backtracking
|
|
|
through a parse tree. With some post processing (cf <code>examples/json.rs</code>),
|
|
|
it can be used to display user friendly error messages</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.ErrorKind.html" title="enum nom::error::ErrorKind">ErrorKind</a></div><div class="desc docblock-short">Indicates which parser returned an error</div></li><li><div class="item-name"><a class="enum" href="enum.VerboseErrorKind.html" title="enum nom::error::VerboseErrorKind">VerboseErrorKind</a></div><div class="desc docblock-short">Error context for <code>VerboseError</code></div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.ContextError.html" title="trait nom::error::ContextError">ContextError</a></div><div class="desc docblock-short">This trait is required by the <code>context</code> combinator to add a static string
|
|
|
to an existing error</div></li><li><div class="item-name"><a class="trait" href="trait.FromExternalError.html" title="trait nom::error::FromExternalError">FromExternalError</a></div><div class="desc docblock-short">This trait is required by the <code>map_res</code> combinator to integrate
|
|
|
error types from external functions, like <a href="https://doc.rust-lang.org/1.76.0/core/str/traits/trait.FromStr.html" title="trait core::str::traits::FromStr">std::str::FromStr</a></div></li><li><div class="item-name"><a class="trait" href="trait.ParseError.html" title="trait nom::error::ParseError">ParseError</a></div><div class="desc docblock-short">This trait must be implemented by the error type of a nom parser.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.append_error.html" title="fn nom::error::append_error">append_error</a></div><div class="desc docblock-short">Combines an existing error with a new one created from the input
|
|
|
position and an <a href="enum.ErrorKind.html" title="enum nom::error::ErrorKind">ErrorKind</a>. This is useful when backtracking
|
|
|
through a parse tree, accumulating error context on the way</div></li><li><div class="item-name"><a class="fn" href="fn.context.html" title="fn nom::error::context">context</a></div><div class="desc docblock-short">Create a new error from an input position, a static string and an existing error.
|
|
|
This is used mainly in the <a href="fn.context.html" title="fn nom::error::context">context</a> combinator, to add user friendly information
|
|
|
to errors when backtracking through a parse tree</div></li><li><div class="item-name"><a class="fn" href="fn.convert_error.html" title="fn nom::error::convert_error">convert_error</a></div><div class="desc docblock-short">Transforms a <code>VerboseError</code> into a trace with input position information</div></li><li><div class="item-name"><a class="fn" href="fn.dbg_dmp.html" title="fn nom::error::dbg_dmp">dbg_dmp</a></div><div class="desc docblock-short">Prints a message and the input if the parser fails.</div></li><li><div class="item-name"><a class="fn" href="fn.error_to_u32.html" title="fn nom::error::error_to_u32">error_to_u32</a></div><div class="desc docblock-short">Converts an ErrorKind to a number</div></li><li><div class="item-name"><a class="fn" href="fn.make_error.html" title="fn nom::error::make_error">make_error</a></div><div class="desc docblock-short">Creates an error from the input position and an <a href="enum.ErrorKind.html" title="enum nom::error::ErrorKind">ErrorKind</a></div></li></ul></section></div></main></body></html> |