blob: f478777f26649a7d61cec38d6629bdeb22ae73c2 [file] [log] [blame]
<!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="A type which has a position."><meta name="keywords" content="rust, rustlang, rust-lang, Positioned"><title>Positioned in combine - 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">&#9776;</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="#">Positioned</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.position">position</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Positioned-for-%26%27a%20%5BT%5D">&amp;&#39;a [T]</a></li><li><a href="#impl-Positioned-for-%26%27a%20mut%20I">&amp;&#39;a mut I</a></li><li><a href="#impl-Positioned-for-%26%27a%20str">&amp;&#39;a str</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In combine</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 class="trait" href="#">Positioned</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/mod.rs.html#76-79">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait Positioned: <a class="trait" href="trait.StreamOnce.html" title="trait combine::StreamOnce">StreamOnce</a> {
fn <a href="#tymethod.position" class="fnname">position</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Position" title="type combine::StreamOnce::Position">Position</a>;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A type which has a position.</p>
</div></details><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/mod.rs.html#78">source</a><h4 class="code-header">fn <a href="#tymethod.position" class="fnname">position</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Position" title="type combine::StreamOnce::Position">Position</a></h4></section></summary><div class="docblock"><p>Returns the current position of the stream.</p>
</div></details></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-Positioned-for-%26%27a%20mut%20I" class="impl has-srclink"><a class="srclink rightside" href="../src/combine/stream/mod.rs.html#413-421">source</a><a href="#impl-Positioned-for-%26%27a%20mut%20I" class="anchor"></a><h3 class="code-header">impl&lt;'a, I&gt; <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a> for &amp;'a mut I<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a> + ?Sized,</span></h3></section></summary><div class="impl-items"><section id="method.position" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/combine/stream/mod.rs.html#418-420">source</a><a href="#method.position" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.position" class="fnname">position</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Position" title="type combine::StreamOnce::Position">Position</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Positioned-for-%26%27a%20str" class="impl has-srclink"><a class="srclink rightside" href="../src/combine/stream/mod.rs.html#501-506">source</a><a href="#impl-Positioned-for-%26%27a%20str" class="anchor"></a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a> for &amp;'a str</h3></section></summary><div class="impl-items"><section id="method.position-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/combine/stream/mod.rs.html#503-505">source</a><a href="#method.position-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.position" class="fnname">position</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Position" title="type combine::StreamOnce::Position">Position</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Positioned-for-%26%27a%20%5BT%5D" class="impl has-srclink"><a class="srclink rightside" href="../src/combine/stream/mod.rs.html#724-732">source</a><a href="#impl-Positioned-for-%26%27a%20%5BT%5D" class="anchor"></a><h3 class="code-header">impl&lt;'a, T&gt; <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a> for &amp;'a [T]<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Clone + PartialEq,</span></h3></section></summary><div class="impl-items"><section id="method.position-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/combine/stream/mod.rs.html#729-731">source</a><a href="#method.position-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.position" class="fnname">position</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Position" title="type combine::StreamOnce::Position">Position</a></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-Positioned-for-SliceStream%3C%27a%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/combine/stream/mod.rs.html#1042-1050">source</a><a href="#impl-Positioned-for-SliceStream%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, T&gt; <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a> for <a class="struct" href="stream/struct.SliceStream.html" title="struct combine::stream::SliceStream">SliceStream</a>&lt;'a, T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: PartialEq + 'a,</span></h3></section><section id="impl-Positioned-for-Stream%3CInput%2C%20X%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/combine/stream/position.rs.html#114-126">source</a><a href="#impl-Positioned-for-Stream%3CInput%2C%20X%3E" class="anchor"></a><h3 class="code-header">impl&lt;Input, X, E&gt; <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a> for combine::stream::position::<a class="struct" href="stream/position/struct.Stream.html" title="struct combine::stream::position::Stream">Stream</a>&lt;Input, X&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Input: <a class="trait" href="trait.StreamOnce.html" title="trait combine::StreamOnce">StreamOnce</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;X: <a class="trait" href="stream/position/trait.Positioner.html" title="trait combine::stream::position::Positioner">Positioner</a>&lt;Input::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Token" title="type combine::StreamOnce::Token">Token</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="error/trait.StreamError.html" title="trait combine::error::StreamError">StreamError</a>&lt;Input::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Token" title="type combine::StreamOnce::Token">Token</a>, Input::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Range" title="type combine::StreamOnce::Range">Range</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;Input::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Error" title="type combine::StreamOnce::Error">Error</a>: <a class="trait" href="trait.ParseError.html" title="trait combine::ParseError">ParseError</a>&lt;Input::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Token" title="type combine::StreamOnce::Token">Token</a>, Input::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Range" title="type combine::StreamOnce::Range">Range</a>, X::<a class="associatedtype" href="stream/position/trait.Positioner.html#associatedtype.Position" title="type combine::stream::position::Positioner::Position">Position</a>, StreamError = E&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;Input::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Error" title="type combine::StreamOnce::Error">Error</a>: <a class="trait" href="trait.ParseError.html" title="trait combine::ParseError">ParseError</a>&lt;Input::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Token" title="type combine::StreamOnce::Token">Token</a>, Input::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Range" title="type combine::StreamOnce::Range">Range</a>, Input::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Position" title="type combine::StreamOnce::Position">Position</a>, StreamError = E&gt;,</span></h3></section><section id="impl-Positioned-for-CompleteStream%3CS%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/combine/stream/mod.rs.html#867-875">source</a><a href="#impl-Positioned-for-CompleteStream%3CS%3E" class="anchor"></a><h3 class="code-header">impl&lt;S&gt; <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a> for <a class="struct" href="stream/struct.CompleteStream.html" title="struct combine::stream::CompleteStream">CompleteStream</a>&lt;S&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a>,</span></h3></section><section id="impl-Positioned-for-MaybePartialStream%3CS%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/combine/stream/mod.rs.html#951-959">source</a><a href="#impl-Positioned-for-MaybePartialStream%3CS%3E" class="anchor"></a><h3 class="code-header">impl&lt;S&gt; <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a> for <a class="struct" href="stream/struct.MaybePartialStream.html" title="struct combine::stream::MaybePartialStream">MaybePartialStream</a>&lt;S&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a>,</span></h3></section><section id="impl-Positioned-for-PartialStream%3CS%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/combine/stream/mod.rs.html#765-773">source</a><a href="#impl-Positioned-for-PartialStream%3CS%3E" class="anchor"></a><h3 class="code-header">impl&lt;S&gt; <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a> for <a class="struct" href="stream/struct.PartialStream.html" title="struct combine::stream::PartialStream">PartialStream</a>&lt;S&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a>,</span></h3></section><section id="impl-Positioned-for-Stream%3CS%2C%20E%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/combine/stream/span.rs.html#144-157">source</a><a href="#impl-Positioned-for-Stream%3CS%2C%20E%3E" class="anchor"></a><h3 class="code-header">impl&lt;S, E&gt; <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a> for combine::stream::span::<a class="struct" href="stream/span/struct.Stream.html" title="struct combine::stream::span::Stream">Stream</a>&lt;S, E&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="trait.StreamOnce.html" title="trait combine::StreamOnce">StreamOnce</a> + <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Token" title="type combine::StreamOnce::Token">Token</a>: PartialEq,<br>&nbsp;&nbsp;&nbsp;&nbsp;S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Range" title="type combine::StreamOnce::Range">Range</a>: PartialEq,<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="trait.ParseError.html" title="trait combine::ParseError">ParseError</a>&lt;S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Token" title="type combine::StreamOnce::Token">Token</a>, S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Range" title="type combine::StreamOnce::Range">Range</a>, <a class="struct" href="stream/span/struct.Span.html" title="struct combine::stream::span::Span">Span</a>&lt;S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Position" title="type combine::StreamOnce::Position">Position</a>&gt;&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Error" title="type combine::StreamOnce::Error">Error</a>: <a class="trait" href="error/trait.ParseErrorInto.html" title="trait combine::error::ParseErrorInto">ParseErrorInto</a>&lt;S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Token" title="type combine::StreamOnce::Token">Token</a>, S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Range" title="type combine::StreamOnce::Range">Range</a>, S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Position" title="type combine::StreamOnce::Position">Position</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Error" title="type combine::StreamOnce::Error">Error</a> as <a class="trait" href="trait.ParseError.html" title="trait combine::ParseError">ParseError</a>&lt;S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Token" title="type combine::StreamOnce::Token">Token</a>, S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Range" title="type combine::StreamOnce::Range">Range</a>, S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Position" title="type combine::StreamOnce::Position">Position</a>&gt;&gt;::<a class="associatedtype" href="trait.ParseError.html#associatedtype.StreamError" title="type combine::ParseError::StreamError">StreamError</a>: <a class="trait" href="error/trait.StreamErrorInto.html" title="trait combine::error::StreamErrorInto">StreamErrorInto</a>&lt;S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Token" title="type combine::StreamOnce::Token">Token</a>, S::<a class="associatedtype" href="trait.StreamOnce.html#associatedtype.Range" title="type combine::StreamOnce::Range">Range</a>&gt;,</span></h3></section><section id="impl-Positioned-for-Stream%3CS%2C%20U%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/combine/stream/state.rs.html#12-20">source</a><a href="#impl-Positioned-for-Stream%3CS%2C%20U%3E" class="anchor"></a><h3 class="code-header">impl&lt;S, U&gt; <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a> for combine::stream::state::<a class="struct" href="stream/state/struct.Stream.html" title="struct combine::stream::state::Stream">Stream</a>&lt;S, U&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="trait.Positioned.html" title="trait combine::Positioned">Positioned</a>,</span></h3></section></div><script src="../implementors/combine/stream/trait.Positioned.js" data-ignore-extern-crates="core" 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>