19 lines
7.4 KiB
HTML
19 lines
7.4 KiB
HTML
<!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="Returns an input slice containing the first N input elements (Input[..N])."><meta name="keywords" content="rust, rustlang, rust-lang, take"><title>take in nom::bytes::streaming - 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" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" 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">☰</button><a class="sidebar-logo" href="../../../nom/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../nom/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In nom::bytes::streaming</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../nom/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../../index.html">nom</a>::<wbr><a href="../index.html">bytes</a>::<wbr><a href="index.html">streaming</a>::<wbr><a class="fn" href="#">take</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></span></h1><span class="out-of-band"><a class="srclink" href="../../../src/nom/bytes/streaming.rs.html#411-423">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn take<C, Input, Error: <a class="trait" href="../../error/trait.ParseError.html" title="trait nom::error::ParseError">ParseError</a><Input>>(<br> count: C<br>) -> impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Input) -> <a class="type" href="../../type.IResult.html" title="type nom::IResult">IResult</a><Input, Input, Error> <span class="where fmt-newline">where<br> Input: <a class="trait" href="../../trait.InputIter.html" title="trait nom::InputIter">InputIter</a> + <a class="trait" href="../../trait.InputTake.html" title="trait nom::InputTake">InputTake</a> + <a class="trait" href="../../trait.InputLength.html" title="trait nom::InputLength">InputLength</a>,<br> C: <a class="trait" href="../../trait.ToUsize.html" title="trait nom::ToUsize">ToUsize</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Returns an input slice containing the first N input elements (Input[..N]).</p>
|
||
<h2 id="streaming-specific"><a href="#streaming-specific">Streaming Specific</a></h2>
|
||
<p><em>Streaming version</em> if the input has less than N elements, <code>take</code> will
|
||
return a <code>Err::Incomplete(Needed::new(M))</code> where M is the number of
|
||
additional bytes the parser would need to succeed.
|
||
It is well defined for <code>&[u8]</code> as the number of elements is the byte size,
|
||
but for types like <code>&str</code>, we cannot know how many bytes correspond for
|
||
the next few chars, so the result will be <code>Err::Incomplete(Needed::Unknown)</code></p>
|
||
<h2 id="example"><a href="#example">Example</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">nom::bytes::streaming::take</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">take6</span>(<span class="ident">s</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span>, <span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> {
|
||
<span class="ident">take</span>(<span class="number">6usize</span>)(<span class="ident">s</span>)
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="ident">take6</span>(<span class="string">"1234567"</span>), <span class="prelude-val">Ok</span>((<span class="string">"7"</span>, <span class="string">"123456"</span>)));
|
||
<span class="macro">assert_eq!</span>(<span class="ident">take6</span>(<span class="string">"things"</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="string">"things"</span>)));
|
||
<span class="macro">assert_eq!</span>(<span class="ident">take6</span>(<span class="string">"short"</span>), <span class="prelude-val">Err</span>(<span class="ident">Err::Incomplete</span>(<span class="ident">Needed::Unknown</span>)));</code></pre></div>
|
||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="nom" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |