blob: 105706589526860e637de7cd1c65237b70b47fb1 [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="Convenience alias over the `StreamError` for the input stream `Input`"><meta name="keywords" content="rust, rustlang, rust-lang, StreamErrorFor"><title>StreamErrorFor in combine::stream - 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 type"><!--[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="#">StreamErrorFor</a></h2><div class="sidebar-elems"><h2><a href="index.html">In combine::stream</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">Type Definition <a href="../index.html">combine</a>::<wbr><a href="index.html">stream</a>::<wbr><a class="type" href="#">StreamErrorFor</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#109-113">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 typedef"><code>pub type StreamErrorFor&lt;Input&gt; = &lt;&lt;Input as <a class="trait" href="../trait.StreamOnce.html" title="trait combine::StreamOnce">StreamOnce</a>&gt;::<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;&lt;Input as <a class="trait" href="../trait.StreamOnce.html" title="trait combine::StreamOnce">StreamOnce</a>&gt;::<a class="associatedtype" href="../trait.StreamOnce.html#associatedtype.Token" title="type combine::StreamOnce::Token">Token</a>, &lt;Input as <a class="trait" href="../trait.StreamOnce.html" title="trait combine::StreamOnce">StreamOnce</a>&gt;::<a class="associatedtype" href="../trait.StreamOnce.html#associatedtype.Range" title="type combine::StreamOnce::Range">Range</a>, &lt;Input as <a class="trait" href="../trait.StreamOnce.html" title="trait combine::StreamOnce">StreamOnce</a>&gt;::<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>;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Convenience alias over the <code>StreamError</code> for the input stream <code>Input</code></p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attribute">#[macro_use]
</span><span class="kw">extern crate </span>combine;
<span class="kw">use </span>combine::{easy, Parser, Stream, many1};
<span class="kw">use </span>combine::parser::char::letter;
<span class="kw">use </span>combine::stream::StreamErrorFor;
<span class="kw">use </span>combine::error::{ParseError, StreamError};
<span class="macro">parser!</span>{
<span class="kw">fn </span>parser[Input]()(Input) -&gt; String
<span class="kw">where </span>[ Input: Stream&lt;Token = char&gt;, ]
{
many1(letter()).and_then(|word: String| {
<span class="kw">if </span>word == <span class="string">&quot;combine&quot; </span>{
<span class="prelude-val">Ok</span>(word)
} <span class="kw">else </span>{
<span class="comment">// The alias makes it easy to refer to the `StreamError` type of `Input`
</span><span class="prelude-val">Err</span>(StreamErrorFor::&lt;Input&gt;::expected_static_message(<span class="string">&quot;combine&quot;</span>))
}
})
}
}
<span class="kw">fn </span>main() {
}</code></pre></div>
</div></details></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>