25 lines
9.0 KiB
HTML
25 lines
9.0 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="Error management"><meta name="keywords" content="rust, rustlang, rust-lang, error"><title>nom::error - 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="../../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 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><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="#">Module error</a></h2><div class="sidebar-elems"><section><div class="block"><ul><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></div></section></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">Module <a href="../index.html">nom</a>::<wbr><a class="mod" href="#">error</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/error.rs.html#1-619">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-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="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Error.html" title="nom::error::Error struct">Error</a></div><div class="item-right docblock-short"><p>default error type, only contains the error’ location and code</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.VerboseError.html" title="nom::error::VerboseError struct">VerboseError</a></div><div class="item-right docblock-short"><p>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</p>
|
||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ErrorKind.html" title="nom::error::ErrorKind enum">ErrorKind</a></div><div class="item-right docblock-short"><p>Indicates which parser returned an error</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.VerboseErrorKind.html" title="nom::error::VerboseErrorKind enum">VerboseErrorKind</a></div><div class="item-right docblock-short"><p>Error context for <code>VerboseError</code></p>
|
||
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ContextError.html" title="nom::error::ContextError trait">ContextError</a></div><div class="item-right docblock-short"><p>This trait is required by the <code>context</code> combinator to add a static string
|
||
to an existing error</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FromExternalError.html" title="nom::error::FromExternalError trait">FromExternalError</a></div><div class="item-right docblock-short"><p>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.64.0/core/str/traits/trait.FromStr.html" title="std::str::FromStr">std::str::FromStr</a></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ParseError.html" title="nom::error::ParseError trait">ParseError</a></div><div class="item-right docblock-short"><p>This trait must be implemented by the error type of a nom parser.</p>
|
||
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.append_error.html" title="nom::error::append_error fn">append_error</a></div><div class="item-right docblock-short"><p>Combines an existing error with a new one created from the input
|
||
position and an <a href="enum.ErrorKind.html" title="ErrorKind">ErrorKind</a>. This is useful when backtracking
|
||
through a parse tree, accumulating error context on the way</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.context.html" title="nom::error::context fn">context</a></div><div class="item-right docblock-short"><p>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="context">context</a> combinator, to add user friendly information
|
||
to errors when backtracking through a parse tree</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.convert_error.html" title="nom::error::convert_error fn">convert_error</a></div><div class="item-right docblock-short"><p>Transforms a <code>VerboseError</code> into a trace with input position information</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.dbg_dmp.html" title="nom::error::dbg_dmp fn">dbg_dmp</a></div><div class="item-right docblock-short"><p>Prints a message and the input if the parser fails.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.error_to_u32.html" title="nom::error::error_to_u32 fn">error_to_u32</a></div><div class="item-right docblock-short"><p>Converts an ErrorKind to a number</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.make_error.html" title="nom::error::make_error fn">make_error</a></div><div class="item-right docblock-short"><p>Creates an error from the input position and an <a href="enum.ErrorKind.html" title="ErrorKind">ErrorKind</a></p>
|
||
</div></div></div></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> |