blob: 87fb55724d0b8c627eade444ddda76674f74341f [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="Decodes `input` using `parser`. Like `decode` but works directly in both `tokio_util::Decoder::decode` and `tokio_util::Decoder::decode_eof`"><meta name="keywords" content="rust, rustlang, rust-lang, decode_tokio"><title>decode_tokio 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 fn"><!--[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><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">Function <a href="../index.html">combine</a>::<wbr><a href="index.html">stream</a>::<wbr><a class="fn" href="#">decode_tokio</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#1346-1376">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 fn"><code>pub fn decode_tokio&lt;Input, P&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;parser: P,<br>&nbsp;&nbsp;&nbsp;&nbsp;input: &amp;mut Input,<br>&nbsp;&nbsp;&nbsp;&nbsp;partial_state: &amp;mut P::<a class="associatedtype" href="../trait.Parser.html#associatedtype.PartialState" title="type combine::Parser::PartialState">PartialState</a><br>) -&gt; Result&lt;(Option&lt;P::<a class="associatedtype" href="../trait.Parser.html#associatedtype.Output" title="type combine::Parser::Output">Output</a>&gt;, usize), &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>&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;P: <a class="trait" href="../trait.Parser.html" title="trait combine::Parser">Parser</a>&lt;Input&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;Input: <a class="trait" href="../trait.RangeStream.html" title="trait combine::RangeStream">RangeStream</a>,</span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Decodes <code>input</code> using <code>parser</code>. Like <code>decode</code> but works directly in both
<code>tokio_util::Decoder::decode</code> and <code>tokio_util::Decoder::decode_eof</code></p>
<p>Return <code>Ok(Some(token), committed_data)</code> if there was enough data to finish parsing using
<code>parser</code>.
Returns <code>Ok(None, committed_data)</code> if <code>input</code> did not contain enough data to finish parsing
using <code>parser</code>.
Returns <code>Ok(None, 0)</code> if <code>input</code> did not contain enough data to finish parsing
using <code>parser</code>.</p>
<p>See <code>examples/async.rs</code> for example usage in a <code>tokio_io::codec::Decoder</code></p>
</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>