mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-20 01:24:23 +00:00
27 lines
5.6 KiB
HTML
27 lines
5.6 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="Predefined callback that will inform the `Lexer` to skip a definition."><title>skip in logos - 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="logos" 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 fn"><!--[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="logo-container" href="../logos/index.html"><img src="https://maciej.codes/kosz/logos.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../logos/index.html"><img src="https://maciej.codes/kosz/logos.png" alt="logo"></a><h2><a href="../logos/index.html">logos</a><span class="version">0.14.0</span></h2></div><div class="sidebar-elems"></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="../logos/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>Function <a href="index.html">logos</a>::<wbr><a class="fn" href="#">skip</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/logos/lib.rs.html#256-258">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn skip<'source, Token: <a class="trait" href="trait.Logos.html" title="trait logos::Logos">Logos</a><'source>>(
|
|||
|
|
_: &mut <a class="struct" href="struct.Lexer.html" title="struct logos::Lexer">Lexer</a><'source, Token>
|
|||
|
|
) -> <a class="struct" href="struct.Skip.html" title="struct logos::Skip">Skip</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Predefined callback that will inform the <code>Lexer</code> to skip a definition.</p>
|
|||
|
|
<h2 id="example"><a href="#example">Example</a></h2>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>logos::Logos;
|
|||
|
|
|
|||
|
|
<span class="attr">#[derive(Logos, Debug, PartialEq)]
|
|||
|
|
</span><span class="kw">enum </span>Token<<span class="lifetime">'a</span>> {
|
|||
|
|
<span class="comment">// We will treat "abc" as if it was whitespace
|
|||
|
|
</span><span class="attr">#[regex(<span class="string">" |abc"</span>, logos::skip, priority = <span class="number">3</span>)]
|
|||
|
|
</span>Ignored,
|
|||
|
|
|
|||
|
|
<span class="attr">#[regex(<span class="string">"[a-zA-Z]+"</span>)]
|
|||
|
|
</span>Text(<span class="kw-2">&</span><span class="lifetime">'a </span>str),
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>tokens: Vec<<span class="kw">_</span>> = Token::lexer(<span class="string">"Hello abc world"</span>).collect();
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(
|
|||
|
|
tokens,
|
|||
|
|
<span class="kw-2">&</span>[
|
|||
|
|
<span class="prelude-val">Ok</span>(Token::Text(<span class="string">"Hello"</span>)),
|
|||
|
|
<span class="prelude-val">Ok</span>(Token::Text(<span class="string">"world"</span>)),
|
|||
|
|
],
|
|||
|
|
);</code></pre></div>
|
|||
|
|
</div></details></section></div></main></body></html>
|