<!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="Core definition for parser input state"><title>Stream in winnow::stream - 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="winnow"data-themes=""data-resource-suffix=""data-rustdoc-version="1.77.1 (7cf61ebde 2024-03-27)"data-channel="1.77.1"data-search-js="search-dd67cee4cfa65049.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../../static.files/storage-4c98445ec4002617.js"></script><scriptdefersrc="sidebar-items.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 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></nav><navclass="sidebar"><divclass="sidebar-crate"><h2><ahref="../../winnow/index.html">winnow</a><spanclass="version">0.6.5</span></h2></div><h2class="location"><ahref="#">Stream</a></h2><divclass="sidebar-elems"><section><h3><ahref="#required-associated-types">Required Associated Types</a></h3><ulclass="block"><li><ahref="#associatedtype.Checkpoint">Checkpoint</a></li><li><ahref="#associatedtype.IterOffsets">IterOffsets</a></li><li><ahref="#associatedtype.Slice">Slice</a></li><li><ahref="#associatedtype.Token">Token</a></li></ul><h3><ahref="#required-methods">Required Methods</a></h3><ulclass="block"><li><ahref="#tymethod.checkpoint">checkpoint</a></li><li><ahref="#tymethod.eof_offset">eof_offset</a></li><li><ahref="#tymethod.iter_offsets">iter_offsets</a></li><li><ahref="#tymethod.next_slice">next_slice</a></li><li><ahref="#tymethod.next_token">next_token</a></li><li><ahref="#tymethod.offset_at">offset_at</a></li><li><ahref="#tymethod.offset_for">offset_for</a></li><li><ahref="#tymethod.raw">raw</a></li><li><ahref="#tymethod.reset">reset</a></li></ul><h3><ahref="#provided-methods">Provided Methods</a></h3><ulclass="block"><li><ahref="#method.finish">finish</a></li><li><ahref="#method.peek_finish">peek_finish</a></li><li><ahref="#method.peek_slice">peek_slice</a></li><li><ahref="#method.peek_token">peek_token</a></li></ul><h3><ahref="#foreign-impls">Implementations on Foreign Types</a></h3><ulclass="block"><li><ahref="#impl-Stream-for-%26%5BT%5D">&'i [T]</a></li><li><ahref="#impl-Stream-for-%26str">&'i str</a></li><li><ahref="#impl-Stream-for-(I,+usize)">(I, usize)</a></li></ul><h3><ahref="#object-safety">Object Safety</a></h3><h3><ahref="#implementors">Implementors</a></h3></section><h2><ahref="index.html">In winnow::str
<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../../winnow/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>Trait <ahref="../index.html">winnow</a>::<wbr><ahref="index.html">stream</a>::<wbr><aclass="trait"href="#">Stream</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/winnow/stream/mod.rs.html#538-637">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub trait Stream: <aclass="trait"href="trait.Offset.html"title="trait winnow::stream::Offset">Offset</a><Self::<aclass="associatedtype"href="trait.Stream.html#associatedtype.Checkpoint"title="type winnow::stream::Stream::Checkpoint">Checkpoint</a>> + <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a> {
type <ahref="#associatedtype.Token"class="associatedtype">Token</a>: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a>;
type <ahref="#associatedtype.Slice"class="associatedtype">Slice</a>: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a>;
type <ahref="#associatedtype.IterOffsets"class="associatedtype">IterOffsets</a>: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = (<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.usize.html">usize</a>, Self::<aclass="associatedtype"href="trait.Stream.html#associatedtype.Token"title="type winnow::stream::Stream::Token">Token</a>)>;
type <ahref="#associatedtype.Checkpoint"class="associatedtype">Checkpoint</a>: <aclass="trait"href="trait.Offset.html"title="trait winnow::stream::Offset">Offset</a> + <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> + <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a>;
</div></details><detailsclass="toggle"open><summary><sectionid="associatedtype.IterOffsets"class="method"><aclass="src rightside"href="../../src/winnow/stream/mod.rs.html#549">source</a><h4class="code-header">type <ahref="#associatedtype.IterOffsets"class="associatedtype">IterOffsets</a>: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = (<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.usize.html">usize</a>, Self::<aclass="associatedtype"href="trait.Stream.html#associatedtype.Token"title="type winnow::stream::Stream::Token">Token</a>)></h4></section></summary><divclass="docblock"><p>Iterate with the offset from the current location</p>
</div></details><detailsclass="toggle"open><summary><sectionid="associatedtype.Checkpoint"class="method"><aclass="src rightside"href="../../src/winnow/stream/mod.rs.html#552">source</a><h4class="code-header">type <ahref="#associatedtype.Checkpoint"class="associatedtype">Checkpoint</a>: <aclass="trait"href="trait.Offset.html"title="trait winnow::stream::Offset">Offset</a> + <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> + <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a></h4></section></summary><divclass="docblock"><p>A parse location within the stream</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.iter_offsets"class="method"><aclass="src rightside"href="../../src/winnow/stream/mod.rs.html#555">source</a><h4class="code-header">fn <ahref="#tymethod.iter_offsets"class="fn">iter_offsets</a>(&self) -> Self::<aclass="associatedtype"href="trait.Stream.html#associatedtype.IterOffsets"title="type winnow::stream::Stream::IterOffsets">IterOffsets</a></h4></section></summary><divclass="docblock"><p>Iterate with the offset from the current location</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="tymethod.eof_offset"class="method"><aclass="src rightside"href="../../src/winnow/stream/mod.rs.html#558">source</a><h4class="code-header">fn <ahref="#tymethod.eof_offset"class="fn">eof_offset</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.usize.html">usize</a></h4></section></summary><divclass="docblock"><p>Returns the offset to the end of the input</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="tymethod.next_token"class="method"><aclass="src rightside"href="../../src/winnow/stream/mod.rs.html#561">source</a><h4class="code-header">fn <ahref="#tymethod.next_token"class="fn">next_token</a>(&mut self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><Self::<aclass="associatedtype"href="trait.Stream.html#associatedtype.Token"title="type winnow::stream::Stream::Token">Token</a>></h4></section></summary><divclass="docblock"><p>Split off the next token from the input</p>
P: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/ops/function/trait.Fn.html"title="trait core::ops::function::Fn">Fn</a>(Self::<aclass="associatedtype"href="trait.Stream.html#associatedtype.Token"title="type winnow::stream::Stream::Token">Token</a>) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>,</div></h4></section></summary><divclass="docblock"><p>Finds the offset of the next matching token</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="tymethod.offset_at"class="method"><aclass="src rightside"href="../../src/winnow/stream/mod.rs.html#580">source</a><h4class="code-header">fn <ahref="#tymethod.offset_at"class="fn">offset_at</a>(&self, tokens: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.usize.html">usize</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.usize.html">usize</a>, <aclass="enum"href="../error/enum.Needed.html"title="enum winnow::error::Needed">Needed</a>></h4></section></summary><divclass="docblock"><p>Get the offset for the number of <code>tokens</code> into the stream</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="tymethod.next_slice"class="method"><aclass="src rightside"href="../../src/winnow/stream/mod.rs.html#598">source</a><h4class="code-header">fn <ahref="#tymethod.next_slice"class="fn">next_slice</a>(&mut self, offset: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.usize.html">usize</a>) -> Self::<aclass="associatedtype"href="trait.Stream.html#associatedtype.Slice"title="type winnow::stream::Stream::Slice">Slice</a></h4></section></summary><divclass="docblock"><p>Split off a slice of tokens from the input</p>
<p><strong>NOTE:</strong> For inputs with variable width tokens, like <code>&str</code>’s <code>char</code>, <code>offset</code> might not correspond
with the number of tokens. To get a valid offset, use:</p>
<li>Indexes must be within bounds of the original input;</li>
<li>Indexes must uphold invariants of the stream, like for <code>str</code> they must lie on UTF-8
sequence boundaries.</li>
</ul>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="tymethod.checkpoint"class="method"><aclass="src rightside"href="../../src/winnow/stream/mod.rs.html#627">source</a><h4class="code-header">fn <ahref="#tymethod.checkpoint"class="fn">checkpoint</a>(&self) -> Self::<aclass="associatedtype"href="trait.Stream.html#associatedtype.Checkpoint"title="type winnow::stream::Stream::Checkpoint">Checkpoint</a></h4></section></summary><divclass="docblock"><p>Save the current parse location within the stream</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="tymethod.reset"class="method"><aclass="src rightside"href="../../src/winnow/stream/mod.rs.html#633">source</a><h4class="code-header">fn <ahref="#tymethod.reset"class="fn">reset</a>(&mut self, checkpoint: &Self::<aclass="associatedtype"href="trait.Stream.html#associatedtype.Checkpoint"title="type winnow::stream::Stream::Checkpoint">Checkpoint</a>)</h4></section></summary><divclass="docblock"><p>Revert the stream to a prior <ahref="trait.Stream.html#associatedtype.Checkpoint"><code>Self::Checkpoint</code></a></p>
Self: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>,</div></h4></section></summary><divclass="docblock"><p>Split off the next token from the input</p>
Self: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>,</div></h4></section></summary><divclass="docblock"><p>Split off a slice of tokens from the input</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.finish"class="method"><aclass="src rightside"href="../../src/winnow/stream/mod.rs.html#612-614">source</a><h4class="code-header">fn <ahref="#method.finish"class="fn">finish</a>(&mut self) -> Self::<aclass="associatedtype"href="trait.Stream.html#associatedtype.Slice"title="type winnow::stream::Stream::Slice">Slice</a></h4></section></summary><divclass="docblock"><p>Advance to the end of the stream</p>
Self: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>,</div></h4></section></summary><divclass="docblock"><p>Advance to the end of the stream</p>
