greg/mentat
1
0
Fork 0
Code Issues 294 Pull requests Projects Releases 9 Packages Wiki Activity
mentat/docs/apis/0.7/rust/mentat_parser_utils/value_and_span/struct.Stream.html

150 lines
14 KiB
HTML
Raw Normal View History

Mentat documentation website using Jekyll (#754) Steps to building docs locally: 1. Install Jekyll 2. cd docs 3. bundle exec jekyll serve --incremental 4. open local docs site at http://127.0.0.1:4000/ * basic Jekyll site * Add docs to documentation site * Update javadoc to allow for error free builds * Remove docs for rust dependencies * Better display examples, about and contributing documentation for Mentat * Version docs
2018-06-25 10:20:36 +00:00
<!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="API documentation for the Rust `Stream` struct in crate `mentat_parser_utils`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Stream">
<title>mentat_parser_utils::value_and_span::Stream - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css"
id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../dark.css">
<link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle">
<script src="../../storage.js"></script>
</head>
<body class="rustdoc struct">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<p class='location'>Struct Stream</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Streaming%3C%27a%3E">Streaming&lt;&#39;a&gt;</a><a href="#impl-StreamOnce">StreamOnce</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>mentat_parser_utils</a>::<wbr><a href='index.html'>value_and_span</a></p><script>window.sidebarCurrent = {name: 'Stream', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>mentat_parser_utils</a>::<wbr><a href='index.html'>value_and_span</a>::<wbr><a class="struct" href=''>Stream</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/mentat_parser_utils/value_and_span.rs.html#120' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Stream&lt;'a&gt;(_, _);</pre></div><div class='docblock'><p>A single <code>combine::Stream</code> implementation iterating <code>edn::ValueAndSpan</code> instances. Equivalent
to <code>combine::IteratorStream</code> as produced by <code>combine::from_iter</code>, but specialized to
<code>edn::ValueAndSpan</code>.</p>
</div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'>
<h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../mentat_parser_utils/value_and_span/struct.Stream.html" title="struct mentat_parser_utils::value_and_span::Stream">Stream</a>&lt;'a&gt;</code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_parser_utils/value_and_span.rs.html#119' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../mentat_parser_utils/value_and_span/struct.Stream.html" title="struct mentat_parser_utils::value_and_span::Stream">Stream</a>&lt;'a&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_parser_utils/value_and_span.rs.html#119' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#117-119' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Streaming%3C%27a%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;'a&gt; <a class="trait" href="../../mentat_parser_utils/value_and_span/trait.Streaming.html" title="trait mentat_parser_utils::value_and_span::Streaming">Streaming</a>&lt;'a&gt; for <a class="struct" href="../../mentat_parser_utils/value_and_span/struct.Stream.html" title="struct mentat_parser_utils::value_and_span::Stream">Stream</a>&lt;'a&gt;</code><a href='#impl-Streaming%3C%27a%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_parser_utils/value_and_span.rs.html#220-224' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.as_stream' class="method"><span id='as_stream.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../mentat_parser_utils/value_and_span/trait.Streaming.html#tymethod.as_stream' class='fnname'>as_stream</a>(self) -&gt; <a class="struct" href="../../mentat_parser_utils/value_and_span/struct.Stream.html" title="struct mentat_parser_utils::value_and_span::Stream">Stream</a>&lt;'a&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_parser_utils/value_and_span.rs.html#221-223' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div><h3 id='impl-StreamOnce' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;'a&gt; StreamOnce for <a class="struct" href="../../mentat_parser_utils/value_and_span/struct.Stream.html" title="struct mentat_parser_utils::value_and_span::Stream">Stream</a>&lt;'a&gt;</code><a href='#impl-StreamOnce' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_parser_utils/value_and_span.rs.html#302-323' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='docblock'><p>Equivalent to <code>combine::IteratorStream</code>.</p>
Fix broken documentation links. (#775) (#767) r=nalexander * Fix broken API doc links Create symlink for latest to point to v0.7. Group APIs by top version number rather than individual * Update swift and android version numbers to match Mentats * Update documentation * Update top level .gitignore to ignore docs site & metatdata * Add README to help with building documentation site * Address review comments @ncalexan
2018-06-29 17:28:44 +00:00
</div><div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='#associatedtype.Item' class="type">Item</a> = &amp;'a <a class="struct" href="../../edn/types/struct.ValueAndSpan.html" title="struct edn::types::ValueAndSpan">ValueAndSpan</a></code></span></h4>
Mentat documentation website using Jekyll (#754) Steps to building docs locally: 1. Install Jekyll 2. cd docs 3. bundle exec jekyll serve --incremental 4. open local docs site at http://127.0.0.1:4000/ * basic Jekyll site * Add docs to documentation site * Update javadoc to allow for error free builds * Remove docs for rust dependencies * Better display examples, about and contributing documentation for Mentat * Version docs
2018-06-25 10:20:36 +00:00
<div class='docblock'><p>The type of items which is yielded from this stream.</p>
Fix broken documentation links. (#775) (#767) r=nalexander * Fix broken API doc links Create symlink for latest to point to v0.7. Group APIs by top version number rather than individual * Update swift and android version numbers to match Mentats * Update documentation * Update top level .gitignore to ignore docs site & metatdata * Add README to help with building documentation site * Address review comments @ncalexan
2018-06-29 17:28:44 +00:00
</div><h4 id='associatedtype.Range' class="type"><span id='Range.t' class='invisible'><code>type <a href='#associatedtype.Range' class="type">Range</a> = &amp;'a <a class="struct" href="../../edn/types/struct.ValueAndSpan.html" title="struct edn::types::ValueAndSpan">ValueAndSpan</a></code></span></h4>
Mentat documentation website using Jekyll (#754) Steps to building docs locally: 1. Install Jekyll 2. cd docs 3. bundle exec jekyll serve --incremental 4. open local docs site at http://127.0.0.1:4000/ * basic Jekyll site * Add docs to documentation site * Update javadoc to allow for error free builds * Remove docs for rust dependencies * Better display examples, about and contributing documentation for Mentat * Version docs
2018-06-25 10:20:36 +00:00
<div class='docblock'><p>The type of a range of items yielded from this stream. Types which do not a have a way of yielding ranges of items should just use the <code>Self::Item</code> for this type. <a href="#associatedtype.Range">Read more</a></p>
</div><h4 id='associatedtype.Position' class="type"><span id='Position.t' class='invisible'><code>type <a href='#associatedtype.Position' class="type">Position</a> = <a class="struct" href="../../mentat_parser_utils/value_and_span/struct.SpanPosition.html" title="struct mentat_parser_utils::value_and_span::SpanPosition">SpanPosition</a></code></span></h4>
<div class='docblock'><p>Type which represents the position in a stream. <code>Ord</code> is required to allow parsers to determine which of two positions are further ahead. <a href="#associatedtype.Position">Read more</a></p>
</div><h4 id='method.uncons' class="method"><span id='uncons.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.uncons' class='fnname'>uncons</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self::Item, Error&lt;Self::Item, Self::Item&gt;&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_parser_utils/value_and_span.rs.html#309-317' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Takes a stream and removes its first item, yielding the item and the rest of the elements. Returns <code>Err</code> if no element could be retrieved. <a href="#tymethod.uncons">Read more</a></p>
</div><h4 id='method.position' class="method"><span id='position.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.position' class='fnname'>position</a>(&amp;self) -&gt; Self::Position</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_parser_utils/value_and_span.rs.html#320-322' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the current position of the stream.</p>
</div></div></div>
<h2 id='synthetic-implementations' class='small-section-header'>
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
</h2>
<div id='synthetic-implementations-list'>
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../mentat_parser_utils/value_and_span/struct.Stream.html" title="struct mentat_parser_utils::value_and_span::Stream">Stream</a>&lt;'a&gt;</code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../mentat_parser_utils/value_and_span/struct.Stream.html" title="struct mentat_parser_utils::value_and_span::Stream">Stream</a>&lt;'a&gt;</code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "mentat_parser_utils";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>
Reference in a new issue Copy permalink