<!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="Stream capability for combinators to parse"><title>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 mod"><!--[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="#">Module stream</a></h2><divclass="sidebar-elems"><section><ulclass="block"><li><ahref="#structs">Structs</a></li><li><ahref="#enums">Enums</a></li><li><ahref="#traits">Traits</a></li><li><ahref="#types">Type Aliases</a></li></ul></section><h2><ahref="../index.html">In crate winnow</a></h2></div></nav><divclass="sidebar-resizer"></div>
<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>Module <ahref="../index.html">winnow</a>::<wbr><aclass="mod"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#1-3649">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"><p>Stream capability for combinators to parse</p>
<p>Stream types include:</p>
<ul>
<li><code>&[u8]</code> and <ahref="struct.Bytes.html"title="struct winnow::stream::Bytes"><code>Bytes</code></a> for binary data</li>
<li><code>&str</code> (aliased as <ahref="type.Str.html"title="type winnow::stream::Str"><code>Str</code></a>) and <ahref="struct.BStr.html"title="struct winnow::stream::BStr"><code>BStr</code></a> for UTF-8 data</li>
<li><ahref="struct.Located.html"title="struct winnow::stream::Located"><code>Located</code></a> can track the location within the original buffer to report
<li><ahref="struct.Stateful.html"title="struct winnow::stream::Stateful"><code>Stateful</code></a> to thread global state through your parsers</li>
<li><ahref="struct.Partial.html"title="struct winnow::stream::Partial"><code>Partial</code></a> can mark an input as partial buffer that is being streamed into</li>
</div></details><h2id="structs"class="section-header">Structs<ahref="#structs"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.BStr.html"title="struct winnow::stream::BStr">BStr</a></div><divclass="desc docblock-short">Improved <code>Debug</code> experience for <code>&[u8]</code> UTF-8-ish streams</div></li><li><divclass="item-name"><aclass="struct"href="struct.BitOffsets.html"title="struct winnow::stream::BitOffsets">BitOffsets</a></div><divclass="desc docblock-short">Iterator for <ahref="../binary/bits/index.html"title="mod winnow::binary::bits">bit</a> stream (<code>(I, usize)</code>)</div></li><li><divclass="item-name"><aclass="struct"href="struct.Bytes.html"title="struct winnow::stream::Bytes">Bytes</a></div><divclass="desc docblock-short">Improved <code>Debug</code> experience for <code>&[u8]</code> byte streams</div></li><li><divclass="item-name"><aclass="struct"href="struct.Checkpoint.html"title="struct winnow::stream::Checkpoint">Checkpoint</a></div><divclass="desc docblock-short">Ensure checkpoint details are kept private</div></li><li><divclass="item-name"><aclass="struct"href="struct.Located.html"title="struct winnow::stream::Located">Located</a></div><divclass="desc docblock-short">Allow collecting the span of a parsed token</div></li><li><divclass="item-name"><aclass="struct"href="struct.Partial.html"title="struct winnow::stream::Partial">Partial</a></div><divclass="desc docblock-short">Mark the input as a partial buffer for streaming input.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Range.html"title="struct winnow::stream::Range">Range</a></div><divclass="desc docblock-short">A range bounded inclusively for counting parses performed</div></li><li><divclass="item-name"><aclass="struct"href="struct.Stateful.html"title="struct winnow::stream::Stateful">Stateful</a></div><divclass="desc docblock-short">Thread global state through your parsers</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.CompareResult.html"title="enum winnow::stream::CompareResult">CompareResult</a></div><divclass="desc docblock-short">Result of <ahref="trait.Compare.html#tymethod.compare"title="method winnow::stream::Compare::compare"><code>Compare::compare</code></a></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.Accumulate.html"title="trait winnow::stream::Accumulate">Accumulate</a></div><divclass="desc docblock-short">Abstracts something which can extend an <code>Extend</code>.
Used to build modified input slices in <code>escaped_transform</code></div></li><li><divclass="item-name"><aclass="trait"href="trait.AsBStr.html"title="trait winnow::stream::AsBStr">AsBStr</a></div><divclass="desc docblock-short">Helper trait for types that can be viewed as a byte slice</div></li><li><divclass="item-name"><aclass="trait"href="trait.AsBytes.html"title="trait winnow::stream::AsBytes">AsBytes</a></div><divclass="desc docblock-short">Helper trait for types that can be viewed as a byte slice</div></li><li><divclass="item-name"><aclass="trait"href="trait.AsChar.html"title="trait winnow::stream::AsChar">AsChar</a></div><divclass="desc docblock-short">Transforms a token into a char for basic string parsing</div></li><li><divclass="item-name"><aclass="trait"href="trait.Compare.html"title="trait winnow::stream::Compare">Compare</a></div><divclass="desc docblock-short">Abstracts comparison operations</div></li><li><divclass="item-name"><aclass="trait"href="trait.ContainsToken.html"title="trait winnow::stream::ContainsToken">ContainsToken</a></div><divclass="desc docblock-short">Check if a token is in a set of possible tokens</div></li><li><divclass="item-name"><aclass="trait"href="trait.FindSlice.html"title="trait winnow::stream::FindSlice">FindSlice</a></div><divclass="desc docblock-short">Look for a slice in self</div></li><li><divclass="item-name"><aclass="trait"href="trait.Location.html"title="trait winnow::stream::Location">Location</a></div><divclass="desc docblock-short">Number of indices input has advanced since start of parsing</div></li><li><divclass="item-name"><aclass="trait"href="trait.Offset.html"title="trait winnow::stream::Offset">Offset</a></div><divclass="desc docblock-short">Useful functions to calculate the offset between slices and show a hexdump of a slice</div></li><li><divclass="item-name"><aclass="trait"href="trait.ParseSlice.html"title="trait winnow::stream::ParseSlice">ParseSlice</a></div><divclass="desc docblock-short">Used to integrate <code>str</code>’s <code>parse()</code> method</div></li><li><divclass="item-name"><aclass="trait"href="trait.SliceLen.html"title="trait winnow::stream::SliceLen">SliceLen</a></div><divclass="desc docblock-short">Abstract method to calculate the input length</div></li><li><divclass="item-name"><aclass="trait"href="trait.Stream.html"title="trait winnow::stream::Stream">Stream</a></div><divclass="desc docblock-short">Core definition for parser input state</div></li><li><divclass="item-name"><aclass="trait"href="trait.StreamIsPartial.html"title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a></div><divclass="desc docblock-short">Marks the input as being the complete buffer or a partial buffer for streaming input</div></li><li><divclass="item-name"><aclass="trait"href="trait.ToUsize.html"title="trait winnow::stream::ToUsize">ToUsize</a></div><divclass="desc docblock-short">Helper trait to convert numbers to usize.</div></li><li><divclass="item-name"><aclass="trait"href="trait.UpdateSlice.html"title="trait winnow::stream::UpdateSlice">UpdateSlice</a></div><divclass="desc docblock-short">Convert a <code>Stream</code> into an appropriate <code>Output</code> type</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.Str.html"title="type winnow::stream::Str">Str</a></div><divclass="desc docblock-short">UTF-8 Stream</div></li></ul></section></div></main></body></html>
