<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="Logos"><title>logos - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-5bc39a1768837dd0.css"><metaname="rustdoc-vars"data-root-path="../"data-static-root-path="../static.files/"data-current-crate="logos"data-themes=""data-resource-suffix=""data-rustdoc-version="1.77.0 (aedd173a2 2024-03-17)"data-channel="1.77.0"data-search-js="search-dd67cee4cfa65049.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../static.files/storage-4c98445ec4002617.js"></script><scriptdefersrc="../crates.js"></script><scriptdefersrc="../static.files/main-48f368f3872407c8.js"></script><noscript><linkrel="stylesheet"href="../static.files/noscript-04d5337699b92874.css"></noscript><linkrel="alternate icon"type="image/png"href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button><aclass="logo-container"href="../logos/index.html"><imgsrc="https://maciej.codes/kosz/logos.png"alt=""></a></nav><navclass="sidebar"><divclass="sidebar-crate"><aclass="logo-container"href="../logos/index.html"><imgsrc="https://maciej.codes/kosz/logos.png"alt="logo"></a><h2><ahref="../logos/index.html">logos</a><spanclass="version">0.14.0</span></h2></div><divclass="sidebar-elems"><ulclass="block">
<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>
