|
|
<!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="This trait is required by the `context` combinator to add a static string to an existing error"><title>ContextError in 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 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></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="#">ContextError</a></h2><div class="sidebar-elems"><section><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.add_context">add_context</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ContextError%3CI%3E-for-()">()</a></li><li><a href="#impl-ContextError%3CI%3E-for-(I,+ErrorKind)">(I, ErrorKind)</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In nom::error</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>Trait <a href="../index.html">nom</a>::<wbr><a href="index.html">error</a>::<wbr><a class="trait" href="#">ContextError</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#39-46">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait ContextError<I>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
|
// Provided method
|
|
|
fn <a href="#method.add_context" class="fn">add_context</a>(_input: I, _ctx: &'static <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>, other: Self) -> Self { ... }
|
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This trait is required by the <code>context</code> combinator to add a static string
|
|
|
to an existing error</p>
|
|
|
</div></details><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.add_context" class="method"><a class="src rightside" href="../../src/nom/error.rs.html#43-45">source</a><h4 class="code-header">fn <a href="#method.add_context" class="fn">add_context</a>(_input: I, _ctx: &'static <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Creates 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</p>
|
|
|
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><section id="impl-ContextError%3CI%3E-for-(I,+ErrorKind)" class="impl"><a class="src rightside" href="../../src/nom/error.rs.html#113">source</a><a href="#impl-ContextError%3CI%3E-for-(I,+ErrorKind)" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="trait.ContextError.html" title="trait nom::error::ContextError">ContextError</a><I> for (I, <a class="enum" href="enum.ErrorKind.html" title="enum nom::error::ErrorKind">ErrorKind</a>)</h3></section><section id="impl-ContextError%3CI%3E-for-()" class="impl"><a class="src rightside" href="../../src/nom/error.rs.html#127">source</a><a href="#impl-ContextError%3CI%3E-for-()" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="trait.ContextError.html" title="trait nom::error::ContextError">ContextError</a><I> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a></h3></section><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-ContextError%3CI%3E-for-Error%3CI%3E" class="impl"><a class="src rightside" href="../../src/nom/error.rs.html#82">source</a><a href="#impl-ContextError%3CI%3E-for-Error%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="trait.ContextError.html" title="trait nom::error::ContextError">ContextError</a><I> for <a class="struct" href="struct.Error.html" title="struct nom::error::Error">Error</a><I></h3></section><section id="impl-ContextError%3CI%3E-for-VerboseError%3CI%3E" class="impl"><a class="src rightside" href="../../src/nom/error.rs.html#193-198">source</a><a href="#impl-ContextError%3CI%3E-for-VerboseError%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="trait.ContextError.html" title="trait nom::error::ContextError">ContextError</a><I> for <a class="struct" href="struct.VerboseError.html" title="struct nom::error::VerboseError">VerboseError</a><I></h3></section></div><script src="../../trait.impl/nom/error/trait.ContextError.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html> |