<!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="Trait implemented for an enum representing all tokens. You should never have to implement it manually, use the `#[derive(Logos)]` attribute on your enum."><title>Logos in logos - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-dd39b87e5fcfba68.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.80.0 (051478957 2024-07-21)"data-channel="1.80.0"data-search-js="search-d52510db62a78183.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../static.files/storage-118b08c4c78b968e.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../static.files/main-20a3ad099b048cf2.js"></script><noscript><linkrel="stylesheet"href="../static.files/noscript-df360f571f6edeae.css"></noscript><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 trait"><!--[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><h2class="location"><ahref="#">Logos</a></h2><divclass="sidebar-elems"><section><h3><ahref="#required-associated-types">Required Associated Types</a></h3><ulclass="block"><li><ahref="#associatedtype.Error">Error</a></li><li><ahref="#associatedtype.Extras">Extras</a></li><li><ahref="#associatedtype.Source">Source</a></li></ul><h3><ahref="#required-methods">Required Methods</a></h3><ulclass="block"><li><ahref="#tymethod.lex">lex</a></li></ul><h3><ahref="#provided-methods">Provided Methods</a></h3><ulclass="block"><li><ahref="#method.lexer">lexer</a></li><li><ahref="#method.lexer_with_extras">lexer_with_extras</a></li></ul><h3><ahref="#object-safety">Object Safety</a></h3><h3><ahref="#implementors">Implementors</a></h3></section><h2><ahref="index.html">In crate logos</a></h2></div></nav><divclass="sidebar-resizer"></div><main><divclass="width-limiter"><rustdoc-search></rustdoc-search><sectionid="main-content"class="content"><divclass="main-heading"><h1>Trait <ahref="index.html">logos</a>::<wbr><aclass="trait"href="#">Logos</a><buttonid="copy-path"title="Copy item path to clipboard">Copy item path</button></h1><spanclass="out-of-band"><aclass="src"href="../src/logos/lib.rs.html#44-79">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub trait Logos<'source>: <aclass="trait"href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a> {
}</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>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.</p>
</div></details><h2id="required-associated-types"class="section-header">Required Associated Types<ahref="#required-associated-types"class="anchor">§</a></h2><divclass="methods"><detailsclass="toggle"open><summary><sectionid="associatedtype.Extras"class="method"><aclass="src rightside"href="../src/logos/lib.rs.html#47">source</a><h4class="code-header">type <ahref="#associatedtype.Extras"class="associatedtype">Extras</a></h4></section></summary><divclass="docblock"><p>Associated type <code>Extras</code> for the particular lexer. This can be set using
<code>#[logos(extras = MyExtras)]</code> and accessed inside callbacks.</p>
</div></details><detailsclass="toggle"open><summary><sectionid="associatedtype.Source"class="method"><aclass="src rightside"href="../src/logos/lib.rs.html#52">source</a><h4class="code-header">type <ahref="#associatedtype.Source"class="associatedtype">Source</a>: <aclass="trait"href="source/trait.Source.html"title="trait logos::source::Source">Source</a> + ?<aclass="trait"href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a> + 'source</h4></section></summary><divclass="docblock"><p>Source type this token can be lexed from. This will default to <code>str</code>,
</div></details><detailsclass="toggle"open><summary><sectionid="associatedtype.Error"class="method"><aclass="src rightside"href="../src/logos/lib.rs.html#56">source</a><h4class="code-header">type <ahref="#associatedtype.Error"class="associatedtype">Error</a>: <aclass="trait"href="https://doc.rust-lang.org/1.80.0/core/default/trait.Default.html"title="trait core::default::Default">Default</a> + <aclass="trait"href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> + <aclass="trait"href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.PartialEq.html"title="trait core::cmp::PartialEq">PartialEq</a> + <aclass="trait"href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a> + 'source</h4></section></summary><divclass="docblock"><p>Error type returned by the lexer. This can be set using
<code>#[logos(error = MyError)]</code>. Defaults to <code>()</code> if not set.</p>
</div></details></div><h2id="required-methods"class="section-header">Required Methods<ahref="#required-methods"class="anchor">§</a></h2><divclass="methods"><detailsclass="toggle method-toggle"open><summary><sectionid="tymethod.lex"class="method"><aclass="src rightside"href="../src/logos/lib.rs.html#60">source</a><h4class="code-header">fn <ahref="#tymethod.lex"class="fn">lex</a>(lexer: &mut <aclass="struct"href="struct.Lexer.html"title="struct logos::Lexer">Lexer</a><'source, Self>)</h4></section></summary><divclass="docblock"><p>The heart of Logos. Called by the <code>Lexer</code>. The implementation for this function
is generated by the <code>logos-derive</code> crate.</p>
Self::<aclass="associatedtype"href="trait.Logos.html#associatedtype.Extras"title="type logos::Logos::Extras">Extras</a>: <aclass="trait"href="https://doc.rust-lang.org/1.80.0/core/default/trait.Default.html"title="trait core::default::Default">Default</a>,</div></h4></section></summary><divclass="docblock"><p>Create a new instance of a <code>Lexer</code> that will produce tokens implementing
) -><aclass="struct"href="struct.Lexer.html"title="struct logos::Lexer">Lexer</a><'source, Self><ahref="#"class="tooltip"data-notable-ty="Lexer<'source, Self>">ⓘ</a></h4></section></summary><divclass="docblock"><p>Create a new instance of a <code>Lexer</code> with the provided <code>Extras</code> that will
produce tokens implementing this <code>Logos</code>.</p>
