<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../logos/all.html"title="show sidebar"></a></div><inputclass="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"><divid="help-button"tabindex="-1"><ahref="../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Crate <aclass="mod"href="#">logos</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../src/logos/lib.rs.html#1-270">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><imgsrc="https://raw.githubusercontent.com/maciejhirsz/logos/master/logos.svg?sanitize=true"alt="Logos logo"width="250"align="right">
<li>To make it easy to create a Lexer, so you can focus on more complex problems.</li>
<li>To make the generated Lexer faster than anything you’d write by hand.</li>
</ul>
<p>To achieve those, <strong>Logos</strong>:</p>
<ul>
<li>Combines all token definitions into a single <ahref="https://en.wikipedia.org/wiki/Deterministic_finite_automaton">deterministic state machine</a>.</li>
<li>Optimizes branches into <ahref="https://en.wikipedia.org/wiki/Lookup_table">lookup tables</a> or <ahref="https://en.wikipedia.org/wiki/Branch_table">jump tables</a>.</li>
</div></details><h2id="reexports"class="section-header">Re-exports<ahref="#reexports"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"id="reexport.Source"><code>pub use crate::source::<aclass="trait"href="source/trait.Source.html"title="trait logos::source::Source">Source</a>;</code></div></li></ul><h2id="modules"class="section-header">Modules<ahref="#modules"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="mod"href="source/index.html"title="mod logos::source">source</a></div><divclass="desc docblock-short">This module contains a bunch of traits necessary for processing byte strings.</div></li></ul><h2id="structs"class="section-header">Structs<ahref="#structs"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.Lexer.html"title="struct logos::Lexer">Lexer</a></div><divclass="desc docblock-short"><code>Lexer</code> is the main struct of the crate that allows you to read through a
<code>Source</code> and produce tokens for enums implementing the <code>Logos</code> trait.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Skip.html"title="struct logos::Skip">Skip</a></div><divclass="desc docblock-short">Type that can be returned from a callback, informing the <code>Lexer</code>, to skip
current token match. See also <ahref="./fn.skip.html"><code>logos::skip</code></a>.</div></li><li><divclass="item-name"><aclass="struct"href="struct.SpannedIter.html"title="struct logos::SpannedIter">SpannedIter</a></div><divclass="desc docblock-short">Iterator that pairs tokens with their position in the source.</div></li></ul><h2id="enums"class="section-header">Enums<ahref="#enums"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="enum"href="enum.Filter.html"title="enum logos::Filter">Filter</a></div><divclass="desc docblock-short">Type that can be returned from a callback, either producing a field
for a token, or skipping it.</div></li><li><divclass="item-name"><aclass="enum"href="enum.FilterResult.html"title="enum logos::FilterResult">FilterResult</a></div><divclass="desc docblock-short">Type that can be returned from a callback, either producing a field
for a token, skipping it, or emitting an error.</div></li></ul><h2id="traits"class="section-header">Traits<ahref="#traits"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="trait"href="trait.Logos.html"title="trait logos::Logos">Logos</a></div><divclass="desc docblock-short">Trait implemented for an enum representing all tokens. You should never have
to implement it manually, use the <code>#[derive(Logos)]</code> attribute on your enum.</div></li></ul><h2id="functions"class="section-header">Functions<ahref="#functions"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="fn"href="fn.skip.html"title="fn logos::skip">skip</a></div><divclass="desc docblock-short">Predefined callback that will inform the <code>Lexer</code> to skip a definition.</div></li></ul><h2id="types"class="section-header">Type Aliases<ahref="#types"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="type"href="type.Span.html"title="type logos::Span">Span</a></div><divclass="desc docblock-short">Byte range in the source.</div></li></ul><h2id="derives"class="section-header">Derive Macros<ahref="#derives"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="derive"href="derive.Logos.html"title="derive logos::Logos">Logos</a></div></li></ul></section></div></main></body></html>
