173 lines
18 KiB
HTML
173 lines
18 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="API documentation for the Rust `ErrorKind` enum in crate `mentat_query_parser`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, ErrorKind">
|
|||
|
|
|
|||
|
|
<title>mentat_query_parser::ErrorKind - Rust</title>
|
|||
|
|
|
|||
|
|
<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="../dark.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
|
|||
|
|
<script src="../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc enum">
|
|||
|
|
<!--[if lte IE 8]>
|
|||
|
|
<div class="warning">
|
|||
|
|
This old browser is unsupported and will most likely display funky
|
|||
|
|
things.
|
|||
|
|
</div>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="sidebar">
|
|||
|
|
<div class="sidebar-menu">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Enum ErrorKind</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Msg">Msg</a><a href="#variant.EdnParseError">EdnParseError</a><a href="#variant.DuplicateVariableError">DuplicateVariableError</a><a href="#variant.NotAVariableError">NotAVariableError</a><a href="#variant.FindParseError">FindParseError</a><a href="#variant.WhereParseError">WhereParseError</a><a href="#variant.WithParseError">WithParseError</a><a href="#variant.InvalidInputError">InvalidInputError</a><a href="#variant.MissingFieldError">MissingFieldError</a><a href="#variant.UnknownLimitVar">UnknownLimitVar</a><a href="#variant.InvalidLimit">InvalidLimit</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.description">description</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-From%3CErrorKind%3E">From<ErrorKind></a><a href="#impl-Debug">Debug</a><a href="#impl-Display">Display</a><a href="#impl-From%3C%26%27a%20str%3E">From<&'a str></a><a href="#impl-From%3CString%3E">From<String></a><a href="#impl-From%3CError%3E">From<Error></a></div></div><p class='location'><a href='index.html'>mentat_query_parser</a></p><script>window.sidebarCurrent = {name: 'ErrorKind', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="theme-picker">
|
|||
|
|
<button id="theme-picker" aria-label="Pick another theme!">
|
|||
|
|
<img src="../brush.svg" width="18" alt="Pick another theme!">
|
|||
|
|
</button>
|
|||
|
|
<div id="theme-choices"></div>
|
|||
|
|
</div>
|
|||
|
|
<script src="../theme.js"></script>
|
|||
|
|
<nav class="sub">
|
|||
|
|
<form class="search-form js-only">
|
|||
|
|
<div class="search-container">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Enum <a href='index.html'>mentat_query_parser</a>::<wbr><a class="enum" href=''>ErrorKind</a></span><span class='out-of-band'><span id='render-detail'>
|
|||
|
|
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
|||
|
|
[<span class='inner'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span></span></h1>
|
|||
|
|
<pre class='rust enum'>pub enum ErrorKind {
|
|||
|
|
Msg(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
|
|||
|
|
EdnParseError(<a class="struct" href="../edn/parse/struct.ParseError.html" title="struct edn::parse::ParseError">ParseError</a>),
|
|||
|
|
DuplicateVariableError,
|
|||
|
|
NotAVariableError(<a class="struct" href="../edn/types/struct.ValueAndSpan.html" title="struct edn::types::ValueAndSpan">ValueAndSpan</a>),
|
|||
|
|
FindParseError(<a class="struct" href="../mentat_parser_utils/struct.ValueParseError.html" title="struct mentat_parser_utils::ValueParseError">ValueParseError</a>),
|
|||
|
|
WhereParseError(<a class="struct" href="../mentat_parser_utils/struct.ValueParseError.html" title="struct mentat_parser_utils::ValueParseError">ValueParseError</a>),
|
|||
|
|
WithParseError,
|
|||
|
|
InvalidInputError(<a class="enum" href="../edn/types/enum.Value.html" title="enum edn::types::Value">Value</a>),
|
|||
|
|
MissingFieldError(<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>),
|
|||
|
|
UnknownLimitVar(<a class="struct" href="../edn/symbols/struct.PlainSymbol.html" title="struct edn::symbols::PlainSymbol">PlainSymbol</a>),
|
|||
|
|
InvalidLimit(<a class="enum" href="../edn/types/enum.Value.html" title="enum edn::types::Value">Value</a>),
|
|||
|
|
// some variants omitted
|
|||
|
|
}</pre><div class='docblock'><p>The kind of an error.</p>
|
|||
|
|
</div><h2 id='variants' class='variants small-section-header'>
|
|||
|
|
Variants<a href='#variants' class='anchor'></a></h2>
|
|||
|
|
<span id="variant.Msg" class="variant small-section-header"><a href="#variant.Msg" class="anchor field"></a><span id='Msg.v' class='invisible'><code>Msg(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>A convenient variant for String.</p>
|
|||
|
|
</div><span id="variant.EdnParseError" class="variant small-section-header"><a href="#variant.EdnParseError" class="anchor field"></a><span id='EdnParseError.v' class='invisible'><code>EdnParseError(<a class="struct" href="../edn/parse/struct.ParseError.html" title="struct edn::parse::ParseError">ParseError</a>)</code></span></span><span id="variant.DuplicateVariableError" class="variant small-section-header"><a href="#variant.DuplicateVariableError" class="anchor field"></a><span id='DuplicateVariableError.v' class='invisible'><code>DuplicateVariableError</code></span></span><span id="variant.NotAVariableError" class="variant small-section-header"><a href="#variant.NotAVariableError" class="anchor field"></a><span id='NotAVariableError.v' class='invisible'><code>NotAVariableError(<a class="struct" href="../edn/types/struct.ValueAndSpan.html" title="struct edn::types::ValueAndSpan">ValueAndSpan</a>)</code></span></span><span id="variant.FindParseError" class="variant small-section-header"><a href="#variant.FindParseError" class="anchor field"></a><span id='FindParseError.v' class='invisible'><code>FindParseError(<a class="struct" href="../mentat_parser_utils/struct.ValueParseError.html" title="struct mentat_parser_utils::ValueParseError">ValueParseError</a>)</code></span></span><span id="variant.WhereParseError" class="variant small-section-header"><a href="#variant.WhereParseError" class="anchor field"></a><span id='WhereParseError.v' class='invisible'><code>WhereParseError(<a class="struct" href="../mentat_parser_utils/struct.ValueParseError.html" title="struct mentat_parser_utils::ValueParseError">ValueParseError</a>)</code></span></span><span id="variant.WithParseError" class="variant small-section-header"><a href="#variant.WithParseError" class="anchor field"></a><span id='WithParseError.v' class='invisible'><code>WithParseError</code></span></span><span id="variant.InvalidInputError" class="variant small-section-header"><a href="#variant.InvalidInputError" class="anchor field"></a><span id='InvalidInputError.v' class='invisible'><code>InvalidInputError(<a class="enum" href="../edn/types/enum.Value.html" title="enum edn::types::Value">Value</a>)</code></span></span><span id="variant.MissingFieldError" class="variant small-section-header"><a href="#variant.MissingFieldError" class="anchor field"></a><span id='MissingFieldError.v' class='invisible'><code>MissingFieldError(<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>)</code></span></span><span id="variant.UnknownLimitVar" class="variant small-section-header"><a href="#variant.UnknownLimitVar" class="anchor field"></a><span id='UnknownLimitVar.v' class='invisible'><code>UnknownLimitVar(<a class="struct" href="../edn/symbols/struct.PlainSymbol.html" title="struct edn::symbols::PlainSymbol">PlainSymbol</a>)</code></span></span><span id="variant.InvalidLimit" class="variant small-section-header"><a href="#variant.InvalidLimit" class="anchor field"></a><span id='InvalidLimit.v' class='invisible'><code>InvalidLimit(<a class="enum" href="../edn/types/enum.Value.html" title="enum edn::types::Value">Value</a>)</code></span></span>
|
|||
|
|
<h2 id='methods' class='small-section-header'>
|
|||
|
|
Methods<a href='#methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="enum" href="../mentat_query_parser/enum.ErrorKind.html" title="enum mentat_query_parser::ErrorKind">ErrorKind</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.description' class="method"><span id='description.v' class='invisible'><code>pub fn <a href='#method.description' class='fnname'>description</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>A string describing the error kind.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-From%3CErrorKind%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="../mentat_query_parser/enum.ErrorKind.html" title="enum mentat_query_parser::ErrorKind">ErrorKind</a>> for <a class="struct" href="../mentat_query_parser/struct.Error.html" title="struct mentat_query_parser::Error">Error</a></code><a href='#impl-From%3CErrorKind%3E' class='anchor'></a></span><span class='out-of-band'></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(e: <a class="enum" href="../mentat_query_parser/enum.ErrorKind.html" title="enum mentat_query_parser::ErrorKind">ErrorKind</a>) -> Self</code></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../mentat_query_parser/enum.ErrorKind.html" title="enum mentat_query_parser::ErrorKind">ErrorKind</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Display' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="../mentat_query_parser/enum.ErrorKind.html" title="enum mentat_query_parser::ErrorKind">ErrorKind</a></code><a href='#impl-Display' class='anchor'></a></span><span class='out-of-band'></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-From%3C%26%27a%20str%3E' class='impl'><span class='in-band'><code>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> for <a class="enum" href="../mentat_query_parser/enum.ErrorKind.html" title="enum mentat_query_parser::ErrorKind">ErrorKind</a></code><a href='#impl-From%3C%26%27a%20str%3E' class='anchor'></a></span><span class='out-of-band'></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(s: &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-From%3CString%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>> for <a class="enum" href="../mentat_query_parser/enum.ErrorKind.html" title="enum mentat_query_parser::ErrorKind">ErrorKind</a></code><a href='#impl-From%3CString%3E' class='anchor'></a></span><span class='out-of-band'></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.from-2' class="method"><span id='from.v-2' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(s: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> Self</code></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-From%3CError%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../mentat_query_parser/struct.Error.html" title="struct mentat_query_parser::Error">Error</a>> for <a class="enum" href="../mentat_query_parser/enum.ErrorKind.html" title="enum mentat_query_parser::ErrorKind">ErrorKind</a></code><a href='#impl-From%3CError%3E' class='anchor'></a></span><span class='out-of-band'></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.from-3' class="method"><span id='from.v-3' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(e: <a class="struct" href="../mentat_query_parser/struct.Error.html" title="struct mentat_query_parser::Error">Error</a>) -> Self</code></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs the conversion.</p>
|
|||
|
|
</div></div></section>
|
|||
|
|
<section id='search' class="content hidden"></section>
|
|||
|
|
|
|||
|
|
<section class="footer"></section>
|
|||
|
|
|
|||
|
|
<aside id="help" class="hidden">
|
|||
|
|
<div>
|
|||
|
|
<h1 class="hidden">Help</h1>
|
|||
|
|
|
|||
|
|
<div class="shortcuts">
|
|||
|
|
<h2>Keyboard Shortcuts</h2>
|
|||
|
|
|
|||
|
|
<dl>
|
|||
|
|
<dt><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse all sections</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="infos">
|
|||
|
|
<h2>Search Tricks</h2>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Prefix searches with a type followed by a colon (e.g.
|
|||
|
|
<code>fn:</code>) to restrict the search to a given type.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Accepted types are: <code>fn</code>, <code>mod</code>,
|
|||
|
|
<code>struct</code>, <code>enum</code>,
|
|||
|
|
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
|||
|
|
and <code>const</code>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Search functions by type signature (e.g.
|
|||
|
|
<code>vec -> usize</code> or <code>* -> vec</code>)
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../";
|
|||
|
|
window.currentCrate = "mentat_query_parser";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|