| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Trait for tracking the current position of a `Stream`."><meta name="keywords" content="rust, rustlang, rust-lang, Positioner"><title>Positioner in combine::stream::position - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../../combine/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../combine/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Positioner</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Checkpoint">Checkpoint</a></li><li><a href="#associatedtype.Position">Position</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.checkpoint">checkpoint</a></li><li><a href="#tymethod.position">position</a></li><li><a href="#tymethod.reset">reset</a></li><li><a href="#tymethod.update">update</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Positioner%3CItem%3E-for-%26mut%20T">&mut T</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In combine::stream::position</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="../../index.html">combine</a>::<wbr><a href="../index.html">stream</a>::<wbr><a href="index.html">position</a>::<wbr><a class="trait" href="#">Positioner</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../../src/combine/stream/position.rs.html#14-27">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait Positioner<Item> { |
| type <a href="#associatedtype.Position" class="associatedtype">Position</a>: Clone + Ord; |
| type <a href="#associatedtype.Checkpoint" class="associatedtype">Checkpoint</a>: Clone; |
| |
| fn <a href="#tymethod.position" class="fnname">position</a>(&self) -> Self::<a class="associatedtype" href="trait.Positioner.html#associatedtype.Position" title="type combine::stream::position::Positioner::Position">Position</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.update" class="fnname">update</a>(&mut self, token: &Item); |
| <span class="item-spacer"></span> fn <a href="#tymethod.checkpoint" class="fnname">checkpoint</a>(&self) -> Self::<a class="associatedtype" href="trait.Positioner.html#associatedtype.Checkpoint" title="type combine::stream::position::Positioner::Checkpoint">Checkpoint</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.reset" class="fnname">reset</a>(&mut self, checkpoint: Self::<a class="associatedtype" href="trait.Positioner.html#associatedtype.Checkpoint" title="type combine::stream::position::Positioner::Checkpoint">Checkpoint</a>); |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for tracking the current position of a <code>Stream</code>.</p> |
| </div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Position" class="method has-srclink"><a class="srclink rightside" href="../../../src/combine/stream/position.rs.html#16">source</a><h4 class="code-header">type <a href="#associatedtype.Position" class="associatedtype">Position</a>: Clone + Ord</h4></section></summary><div class="docblock"><p>The type which keeps track of the position</p> |
| </div></details><section id="associatedtype.Checkpoint" class="method has-srclink"><a class="srclink rightside" href="../../../src/combine/stream/position.rs.html#18">source</a><h4 class="code-header">type <a href="#associatedtype.Checkpoint" class="associatedtype">Checkpoint</a>: Clone</h4></section></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.position" class="method has-srclink"><a class="srclink rightside" href="../../../src/combine/stream/position.rs.html#21">source</a><h4 class="code-header">fn <a href="#tymethod.position" class="fnname">position</a>(&self) -> Self::<a class="associatedtype" href="trait.Positioner.html#associatedtype.Position" title="type combine::stream::position::Positioner::Position">Position</a></h4></section></summary><div class="docblock"><p>Returns the current position</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.update" class="method has-srclink"><a class="srclink rightside" href="../../../src/combine/stream/position.rs.html#23">source</a><h4 class="code-header">fn <a href="#tymethod.update" class="fnname">update</a>(&mut self, token: &Item)</h4></section></summary><div class="docblock"><p>Updates the position given that <code>token</code> has been taken from the stream</p> |
| </div></details><section id="tymethod.checkpoint" class="method has-srclink"><a class="srclink rightside" href="../../../src/combine/stream/position.rs.html#25">source</a><h4 class="code-header">fn <a href="#tymethod.checkpoint" class="fnname">checkpoint</a>(&self) -> Self::<a class="associatedtype" href="trait.Positioner.html#associatedtype.Checkpoint" title="type combine::stream::position::Positioner::Checkpoint">Checkpoint</a></h4></section><section id="tymethod.reset" class="method has-srclink"><a class="srclink rightside" href="../../../src/combine/stream/position.rs.html#26">source</a><h4 class="code-header">fn <a href="#tymethod.reset" class="fnname">reset</a>(&mut self, checkpoint: Self::<a class="associatedtype" href="trait.Positioner.html#associatedtype.Checkpoint" title="type combine::stream::position::Positioner::Checkpoint">Checkpoint</a>)</h4></section></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Positioner%3CItem%3E-for-%26mut%20T" class="impl has-srclink"><a class="srclink rightside" href="../../../src/combine/stream/position.rs.html#154-181">source</a><a href="#impl-Positioner%3CItem%3E-for-%26mut%20T" class="anchor"></a><h3 class="code-header">impl<Item, T> <a class="trait" href="trait.Positioner.html" title="trait combine::stream::position::Positioner">Positioner</a><Item> for &mut T<span class="where fmt-newline">where<br> Item: Clone,<br> T: ?Sized + <a class="trait" href="trait.Positioner.html" title="trait combine::stream::position::Positioner">Positioner</a><Item>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Position-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Position-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Position" class="associatedtype">Position</a> = <T as <a class="trait" href="trait.Positioner.html" title="trait combine::stream::position::Positioner">Positioner</a><Item>>::<a class="associatedtype" href="trait.Positioner.html#associatedtype.Position" title="type combine::stream::position::Positioner::Position">Position</a></h4></section><section id="associatedtype.Checkpoint-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Checkpoint-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Checkpoint" class="associatedtype">Checkpoint</a> = <T as <a class="trait" href="trait.Positioner.html" title="trait combine::stream::position::Positioner">Positioner</a><Item>>::<a class="associatedtype" href="trait.Positioner.html#associatedtype.Checkpoint" title="type combine::stream::position::Positioner::Checkpoint">Checkpoint</a></h4></section><section id="method.position" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/combine/stream/position.rs.html#163-165">source</a><a href="#method.position" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.position" class="fnname">position</a>(&self) -> T::<a class="associatedtype" href="trait.Positioner.html#associatedtype.Position" title="type combine::stream::position::Positioner::Position">Position</a></h4></section><section id="method.update" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/combine/stream/position.rs.html#168-170">source</a><a href="#method.update" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.update" class="fnname">update</a>(&mut self, item: &Item)</h4></section><section id="method.checkpoint" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/combine/stream/position.rs.html#173-175">source</a><a href="#method.checkpoint" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.checkpoint" class="fnname">checkpoint</a>(&self) -> Self::<a class="associatedtype" href="trait.Positioner.html#associatedtype.Checkpoint" title="type combine::stream::position::Positioner::Checkpoint">Checkpoint</a></h4></section><section id="method.reset" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/combine/stream/position.rs.html#178-180">source</a><a href="#method.reset" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.reset" class="fnname">reset</a>(&mut self, checkpoint: Self::<a class="associatedtype" href="trait.Positioner.html#associatedtype.Checkpoint" title="type combine::stream::position::Positioner::Checkpoint">Checkpoint</a>)</h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Positioner%3Cchar%3E-for-SourcePosition" class="impl has-srclink"><a class="srclink rightside" href="../../../src/combine/stream/position.rs.html#275-302">source</a><a href="#impl-Positioner%3Cchar%3E-for-SourcePosition" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Positioner.html" title="trait combine::stream::position::Positioner">Positioner</a><char> for <a class="struct" href="struct.SourcePosition.html" title="struct combine::stream::position::SourcePosition">SourcePosition</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Position-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Position-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Position" class="associatedtype">Position</a> = <a class="struct" href="struct.SourcePosition.html" title="struct combine::stream::position::SourcePosition">SourcePosition</a></h4></section><section id="associatedtype.Checkpoint-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Checkpoint-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Checkpoint" class="associatedtype">Checkpoint</a> = <a class="struct" href="struct.SourcePosition.html" title="struct combine::stream::position::SourcePosition">SourcePosition</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Positioner%3Cu8%3E-for-SourcePosition" class="impl has-srclink"><a class="srclink rightside" href="../../../src/combine/stream/position.rs.html#304-331">source</a><a href="#impl-Positioner%3Cu8%3E-for-SourcePosition" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Positioner.html" title="trait combine::stream::position::Positioner">Positioner</a><u8> for <a class="struct" href="struct.SourcePosition.html" title="struct combine::stream::position::SourcePosition">SourcePosition</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Position-3" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Position-3" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Position" class="associatedtype">Position</a> = <a class="struct" href="struct.SourcePosition.html" title="struct combine::stream::position::SourcePosition">SourcePosition</a></h4></section><section id="associatedtype.Checkpoint-3" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Checkpoint-3" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Checkpoint" class="associatedtype">Checkpoint</a> = <a class="struct" href="struct.SourcePosition.html" title="struct combine::stream::position::SourcePosition">SourcePosition</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Positioner%3CItem%3E-for-IndexPositioner" class="impl has-srclink"><a class="srclink rightside" href="../../../src/combine/stream/position.rs.html#200-226">source</a><a href="#impl-Positioner%3CItem%3E-for-IndexPositioner" class="anchor"></a><h3 class="code-header">impl<Item> <a class="trait" href="trait.Positioner.html" title="trait combine::stream::position::Positioner">Positioner</a><Item> for <a class="struct" href="struct.IndexPositioner.html" title="struct combine::stream::position::IndexPositioner">IndexPositioner</a><span class="where fmt-newline">where<br> Item: Clone,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Position-4" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Position-4" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Position" class="associatedtype">Position</a> = usize</h4></section><section id="associatedtype.Checkpoint-4" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Checkpoint-4" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Checkpoint" class="associatedtype">Checkpoint</a> = <a class="struct" href="struct.IndexPositioner.html" title="struct combine::stream::position::IndexPositioner">IndexPositioner</a></h4></section></div></details></div><script src="../../../implementors/combine/stream/position/trait.Positioner.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="combine" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
