edlang/edlang_parser/error/type.Error.html
2024-03-13 11:26:54 +00:00

34 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `Error` type in crate `edlang_parser`."><title>Error in edlang_parser::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="edlang_parser" 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 type"><!--[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">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../edlang_parser/index.html">edlang_parser</a><span class="version">0.0.1-alpha.16</span></h2></div><h2 class="location"><a href="#">Error</a></h2><div class="sidebar-elems"><section><h3><a href="#aliased-type">Aliased type</a></h3><h3><a href="#variants">Variants</a></h3><ul class="block variant"><li><a href="#variant.ExtraToken">ExtraToken</a></li><li><a href="#variant.InvalidToken">InvalidToken</a></li><li><a href="#variant.UnrecognizedEof">UnrecognizedEof</a></li><li><a href="#variant.UnrecognizedToken">UnrecognizedToken</a></li><li><a href="#variant.User">User</a></li></ul></section><h2><a href="index.html">In edlang_parser::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="../../edlang_parser/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>Type Alias <a href="../index.html">edlang_parser</a>::<wbr><a href="index.html">error</a>::<wbr><a class="type" 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/edlang_parser/error.rs.html#4">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub type Error = <a class="enum" href="../../lalrpop_util/enum.ParseError.html" title="enum lalrpop_util::ParseError">ParseError</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>, <a class="enum" href="../tokens/enum.Token.html" title="enum edlang_parser::tokens::Token">Token</a>, <a class="enum" href="../lexer/enum.LexicalError.html" title="enum edlang_parser::lexer::LexicalError">LexicalError</a>&gt;;</code></pre><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>enum Error {
InvalidToken {
location: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>,
},
UnrecognizedEof {
location: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>,
expected: <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,
},
UnrecognizedToken {
token: (<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>, <a class="enum" href="../tokens/enum.Token.html" title="enum edlang_parser::tokens::Token">Token</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>),
expected: <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,
},
ExtraToken {
token: (<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>, <a class="enum" href="../tokens/enum.Token.html" title="enum edlang_parser::tokens::Token">Token</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>),
},
User {
error: <a class="enum" href="../lexer/enum.LexicalError.html" title="enum edlang_parser::lexer::LexicalError">LexicalError</a>,
},
}</code></pre><h2 id="variants" class="variants section-header">Variants<a href="#variants" class="anchor">§</a></h2><div class="variants"><section id="variant.InvalidToken" class="variant"><a href="#variant.InvalidToken" class="anchor">§</a><h3 class="code-header">InvalidToken</h3></section><div class="sub-variant" id="variant.InvalidToken.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.InvalidToken.field.location" class="section-header"><a href="#variant.InvalidToken.field.location" class="anchor field">§</a><code>location: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a></code></span></div></div><div class="docblock"><p>Generated by the parser when it encounters a token (or EOF) it did not
expect.</p>
</div><section id="variant.UnrecognizedEof" class="variant"><a href="#variant.UnrecognizedEof" class="anchor">§</a><h3 class="code-header">UnrecognizedEof</h3></section><div class="sub-variant" id="variant.UnrecognizedEof.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.UnrecognizedEof.field.location" class="section-header"><a href="#variant.UnrecognizedEof.field.location" class="anchor field">§</a><code>location: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a></code></span><div class="docblock"><p>The end of the final token</p>
</div></div><div class="sub-variant-field"><span id="variant.UnrecognizedEof.field.expected" class="section-header"><a href="#variant.UnrecognizedEof.field.expected" class="anchor field">§</a><code>expected: <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;</code></span><div class="docblock"><p>The set of expected tokens: these names are taken from the
grammar and hence may not necessarily be suitable for
presenting to the user.</p>
</div></div></div><div class="docblock"><p>Generated by the parser when it encounters an EOF it did not expect.</p>
</div><section id="variant.UnrecognizedToken" class="variant"><a href="#variant.UnrecognizedToken" class="anchor">§</a><h3 class="code-header">UnrecognizedToken</h3></section><div class="sub-variant" id="variant.UnrecognizedToken.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.UnrecognizedToken.field.token" class="section-header"><a href="#variant.UnrecognizedToken.field.token" class="anchor field">§</a><code>token: (<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>, <a class="enum" href="../tokens/enum.Token.html" title="enum edlang_parser::tokens::Token">Token</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>)</code></span><div class="docblock"><p>The unexpected token of type <code>T</code> with a span given by the two <code>L</code> values.</p>
</div></div><div class="sub-variant-field"><span id="variant.UnrecognizedToken.field.expected" class="section-header"><a href="#variant.UnrecognizedToken.field.expected" class="anchor field">§</a><code>expected: <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;</code></span><div class="docblock"><p>The set of expected tokens: these names are taken from the
grammar and hence may not necessarily be suitable for
presenting to the user.</p>
</div></div></div><div class="docblock"><p>Generated by the parser when it encounters a token it did not expect.</p>
</div><section id="variant.ExtraToken" class="variant"><a href="#variant.ExtraToken" class="anchor">§</a><h3 class="code-header">ExtraToken</h3></section><div class="sub-variant" id="variant.ExtraToken.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.ExtraToken.field.token" class="section-header"><a href="#variant.ExtraToken.field.token" class="anchor field">§</a><code>token: (<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>, <a class="enum" href="../tokens/enum.Token.html" title="enum edlang_parser::tokens::Token">Token</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>)</code></span></div></div><div class="docblock"><p>Generated by the parser when it encounters additional, unexpected tokens.</p>
</div><section id="variant.User" class="variant"><a href="#variant.User" class="anchor">§</a><h3 class="code-header">User</h3></section><div class="sub-variant" id="variant.User.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.User.field.error" class="section-header"><a href="#variant.User.field.error" class="anchor field">§</a><code>error: <a class="enum" href="../lexer/enum.LexicalError.html" title="enum edlang_parser::lexer::LexicalError">LexicalError</a></code></span></div></div><div class="docblock"><p>Custom error type.</p>
</div></div><script src="../../type.impl/lalrpop_util/enum.ParseError.js" data-self-path="edlang_parser::error::Error" async></script></section></div></main></body></html>