520 lines
89 KiB
HTML
520 lines
89 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="API documentation for the Rust `Buf` trait in crate `bytes`."><meta name="keywords" content="rust, rustlang, rust-lang, Buf"><title>bytes::Buf - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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">☰</div><a href='../bytes/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Buf</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.advance">advance</a><a href="#tymethod.bytes">bytes</a><a href="#tymethod.remaining">remaining</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.by_ref">by_ref</a><a href="#method.bytes_vec">bytes_vec</a><a href="#method.chain">chain</a><a href="#method.collect">collect</a><a href="#method.copy_to_slice">copy_to_slice</a><a href="#method.get_f32_be">get_f32_be</a><a href="#method.get_f32_le">get_f32_le</a><a href="#method.get_f64_be">get_f64_be</a><a href="#method.get_f64_le">get_f64_le</a><a href="#method.get_i16_be">get_i16_be</a><a href="#method.get_i16_le">get_i16_le</a><a href="#method.get_i32_be">get_i32_be</a><a href="#method.get_i32_le">get_i32_le</a><a href="#method.get_i64_be">get_i64_be</a><a href="#method.get_i64_le">get_i64_le</a><a href="#method.get_i8">get_i8</a><a href="#method.get_int_be">get_int_be</a><a href="#method.get_int_le">get_int_le</a><a href="#method.get_u16_be">get_u16_be</a><a href="#method.get_u16_le">get_u16_le</a><a href="#method.get_u32_be">get_u32_be</a><a href="#method.get_u32_le">get_u32_le</a><a href="#method.get_u64_be">get_u64_be</a><a href="#method.get_u64_le">get_u64_le</a><a href="#method.get_u8">get_u8</a><a href="#method.get_uint_be">get_uint_be</a><a href="#method.get_uint_le">get_uint_le</a><a href="#method.has_remaining">has_remaining</a><a href="#method.iter">iter</a><a href="#method.reader">reader</a><a href="#method.take">take</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Buf-for-%26%27a%20mut%20T">&'a mut T</a><a href="#impl-Buf-for-Box%3CT%3E">Box<T></a><a href="#impl-Buf-for-Cursor%3CT%3E">Cursor<T></a><a href="#impl-Buf-for-Option%3C%5Bu8%3B%201%5D%3E">Option<[u8; 1]></a><a href="#impl-Buf-for-VecDeque%3Cu8%3E">VecDeque<u8></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>bytes</a></p><script>window.sidebarCurrent = {name: 'Buf', ty: 'trait', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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'>−</span>]</a></span><a class='srclink' href='../src/bytes/buf/buf.rs.html#64-1053' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>bytes</a>::<wbr><a class="trait" href=''>Buf</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Buf {
|
||
fn <a href='#tymethod.remaining' class='fnname'>remaining</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.bytes' class='fnname'>bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.advance' class='fnname'>advance</a>(&mut self, cnt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>);
|
||
|
||
fn <a href='#method.bytes_vec' class='fnname'>bytes_vec</a><'a>(&'a self, dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a>&'a <a class="struct" href="../iovec/struct.IoVec.html" title="struct iovec::IoVec">IoVec</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.has_remaining' class='fnname'>has_remaining</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.copy_to_slice' class='fnname'>copy_to_slice</a>(&mut self, dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_u8' class='fnname'>get_u8</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_i8' class='fnname'>get_i8</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_u16_be' class='fnname'>get_u16_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_u16_le' class='fnname'>get_u16_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_i16_be' class='fnname'>get_i16_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_i16_le' class='fnname'>get_i16_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_u32_be' class='fnname'>get_u32_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_u32_le' class='fnname'>get_u32_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_i32_be' class='fnname'>get_i32_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_i32_le' class='fnname'>get_i32_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_u64_be' class='fnname'>get_u64_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_u64_le' class='fnname'>get_u64_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_i64_be' class='fnname'>get_i64_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_i64_le' class='fnname'>get_i64_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_uint_be' class='fnname'>get_uint_be</a>(&mut self, nbytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_uint_le' class='fnname'>get_uint_le</a>(&mut self, nbytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_int_be' class='fnname'>get_int_be</a>(&mut self, nbytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_int_le' class='fnname'>get_int_le</a>(&mut self, nbytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_f32_be' class='fnname'>get_f32_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_f32_le' class='fnname'>get_f32_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_f64_be' class='fnname'>get_f64_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.get_f64_le' class='fnname'>get_f64_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.collect' class='fnname'>collect</a><B>(self) -> B<br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> B: <a class="trait" href="../bytes/buf/trait.FromBuf.html" title="trait bytes::buf::FromBuf">FromBuf</a></span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.take' class='fnname'>take</a>(self, limit: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../bytes/buf/struct.Take.html" title="struct bytes::buf::Take">Take</a><Self><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.chain' class='fnname'>chain</a><U>(self, next: U) -> <a class="struct" href="../bytes/buf/struct.Chain.html" title="struct bytes::buf::Chain">Chain</a><Self, U::<a class="type" href="../bytes/buf/trait.IntoBuf.html#associatedtype.Buf" title="type bytes::buf::IntoBuf::Buf">Buf</a>><br> <span class="where">where<br> U: <a class="trait" href="../bytes/buf/trait.IntoBuf.html" title="trait bytes::buf::IntoBuf">IntoBuf</a>,<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.by_ref' class='fnname'>by_ref</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self<br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.reader' class='fnname'>reader</a>(self) -> <a class="struct" href="../bytes/buf/struct.Reader.html" title="struct bytes::buf::Reader">Reader</a><Self><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.iter' class='fnname'>iter</a>(self) -> <a class="struct" href="../bytes/buf/struct.Iter.html" title="struct bytes::buf::Iter">Iter</a><Self><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
|
||
{ ... }
|
||
}</pre></div><div class='docblock'><p>Read bytes from a buffer.</p>
|
||
<p>A buffer stores bytes in memory such that read operations are infallible.
|
||
The underlying storage may or may not be in contiguous memory. A <code>Buf</code> value
|
||
is a cursor into the buffer. Reading from <code>Buf</code> advances the cursor
|
||
position. It can be thought of as an efficient <code>Iterator</code> for collections of
|
||
bytes.</p>
|
||
<p>The simplest <code>Buf</code> is a <code>Cursor</code> wrapping a <code>[u8]</code>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"hello world"</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'h'</span>, <span class="ident">buf</span>.<span class="ident">get_u8</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'e'</span>, <span class="ident">buf</span>.<span class="ident">get_u8</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'l'</span>, <span class="ident">buf</span>.<span class="ident">get_u8</span>());
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rest</span> <span class="op">=</span> [<span class="number">0</span>; <span class="number">8</span>];
|
||
<span class="ident">buf</span>.<span class="ident">copy_to_slice</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">rest</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="ident">rest</span>[..], <span class="string">b"lo world"</span>);</pre></div>
|
||
</div>
|
||
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.remaining' class='method'><code id='remaining.v'>fn <a href='#tymethod.remaining' class='fnname'>remaining</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h3><div class='docblock'><p>Returns the number of bytes between the current position and the end of
|
||
the buffer.</p>
|
||
<p>This value is greater than or equal to the length of the slice returned
|
||
by <code>bytes</code>.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"hello world"</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">buf</span>.<span class="ident">remaining</span>(), <span class="number">11</span>);
|
||
|
||
<span class="ident">buf</span>.<span class="ident">get_u8</span>();
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">buf</span>.<span class="ident">remaining</span>(), <span class="number">10</span>);</pre></div>
|
||
<h1 id="implementer-notes" class="section-header"><a href="#implementer-notes">Implementer notes</a></h1>
|
||
<p>Implementations of <code>remaining</code> should ensure that the return value does
|
||
not change unless a call is made to <code>advance</code> or any other function that
|
||
is documented to change the <code>Buf</code>'s current position.</p>
|
||
</div><h3 id='tymethod.bytes' class='method'><code id='bytes.v'>fn <a href='#tymethod.bytes' class='fnname'>bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></h3><div class='docblock'><p>Returns a slice starting at the current position and of length between 0
|
||
and <code>Buf::remaining()</code>. Note that this <em>can</em> return shorter slice (this allows
|
||
non-continuous internal representation).</p>
|
||
<p>This is a lower level function. Most operations are done with other
|
||
functions.</p>
|
||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"hello world"</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">buf</span>.<span class="ident">bytes</span>(), <span class="string">b"hello world"</span>);
|
||
|
||
<span class="ident">buf</span>.<span class="ident">advance</span>(<span class="number">6</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">buf</span>.<span class="ident">bytes</span>(), <span class="string">b"world"</span>);</pre></div>
|
||
<h1 id="implementer-notes-1" class="section-header"><a href="#implementer-notes-1">Implementer notes</a></h1>
|
||
<p>This function should never panic. Once the end of the buffer is reached,
|
||
i.e., <code>Buf::remaining</code> returns 0, calls to <code>bytes</code> should return an
|
||
empty slice.</p>
|
||
</div><h3 id='tymethod.advance' class='method'><code id='advance.v'>fn <a href='#tymethod.advance' class='fnname'>advance</a>(&mut self, cnt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code></h3><div class='docblock'><p>Advance the internal cursor of the Buf</p>
|
||
<p>The next call to <code>bytes</code> will return a slice starting <code>cnt</code> bytes
|
||
further into the underlying buffer.</p>
|
||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"hello world"</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">buf</span>.<span class="ident">bytes</span>(), <span class="string">b"hello world"</span>);
|
||
|
||
<span class="ident">buf</span>.<span class="ident">advance</span>(<span class="number">6</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">buf</span>.<span class="ident">bytes</span>(), <span class="string">b"world"</span>);</pre></div>
|
||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||
<p>This function <strong>may</strong> panic if <code>cnt > self.remaining()</code>.</p>
|
||
<h1 id="implementer-notes-2" class="section-header"><a href="#implementer-notes-2">Implementer notes</a></h1>
|
||
<p>It is recommended for implementations of <code>advance</code> to panic if <code>cnt > self.remaining()</code>. If the implementation does not panic, the call must
|
||
behave as if <code>cnt == self.remaining()</code>.</p>
|
||
<p>A call with <code>cnt == 0</code> should never panic and be a no-op.</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.bytes_vec' class='method'><code id='bytes_vec.v'>fn <a href='#method.bytes_vec' class='fnname'>bytes_vec</a><'a>(&'a self, dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a>&'a <a class="struct" href="../iovec/struct.IoVec.html" title="struct iovec::IoVec">IoVec</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h3><div class='docblock'><p>Fills <code>dst</code> with potentially multiple slices starting at <code>self</code>'s
|
||
current position.</p>
|
||
<p>If the <code>Buf</code> is backed by disjoint slices of bytes, <code>bytes_vec</code> enables
|
||
fetching more than one slice at once. <code>dst</code> is a slice of <code>IoVec</code>
|
||
references, enabling the slice to be directly used with <a href="http://man7.org/linux/man-pages/man2/readv.2.html"><code>writev</code></a>
|
||
without any further conversion. The sum of the lengths of all the
|
||
buffers in <code>dst</code> will be less than or equal to <code>Buf::remaining()</code>.</p>
|
||
<p>The entries in <code>dst</code> will be overwritten, but the data <strong>contained</strong> by
|
||
the slices <strong>will not</strong> be modified. If <code>bytes_vec</code> does not fill every
|
||
entry in <code>dst</code>, then <code>dst</code> is guaranteed to contain all remaining slices
|
||
in `self.</p>
|
||
<p>This is a lower level function. Most operations are done with other
|
||
functions.</p>
|
||
<h1 id="implementer-notes-3" class="section-header"><a href="#implementer-notes-3">Implementer notes</a></h1>
|
||
<p>This function should never panic. Once the end of the buffer is reached,
|
||
i.e., <code>Buf::remaining</code> returns 0, calls to <code>bytes_vec</code> must return 0
|
||
without mutating <code>dst</code>.</p>
|
||
<p>Implementations should also take care to properly handle being called
|
||
with <code>dst</code> being a zero length slice.</p>
|
||
</div><h3 id='method.has_remaining' class='method'><code id='has_remaining.v'>fn <a href='#method.has_remaining' class='fnname'>has_remaining</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns true if there are any more bytes to consume</p>
|
||
<p>This is equivalent to <code>self.remaining() != 0</code>.</p>
|
||
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"a"</span>);
|
||
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">buf</span>.<span class="ident">has_remaining</span>());
|
||
|
||
<span class="ident">buf</span>.<span class="ident">get_u8</span>();
|
||
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">buf</span>.<span class="ident">has_remaining</span>());</pre></div>
|
||
</div><h3 id='method.copy_to_slice' class='method'><code id='copy_to_slice.v'>fn <a href='#method.copy_to_slice' class='fnname'>copy_to_slice</a>(&mut self, dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>)</code></h3><div class='docblock'><p>Copies bytes from <code>self</code> into <code>dst</code>.</p>
|
||
<p>The cursor is advanced by the number of bytes copied. <code>self</code> must have
|
||
enough remaining bytes to fill <code>dst</code>.</p>
|
||
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"hello world"</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">dst</span> <span class="op">=</span> [<span class="number">0</span>; <span class="number">5</span>];
|
||
|
||
<span class="ident">buf</span>.<span class="ident">copy_to_slice</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">dst</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b"hello"</span>, <span class="kw-2">&</span><span class="ident">dst</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">6</span>, <span class="ident">buf</span>.<span class="ident">remaining</span>());</pre></div>
|
||
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
|
||
<p>This function panics if <code>self.remaining() < dst.len()</code></p>
|
||
</div><h3 id='method.get_u8' class='method'><code id='get_u8.v'>fn <a href='#method.get_u8' class='fnname'>get_u8</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code></h3><div class='docblock'><p>Gets an unsigned 8 bit integer from <code>self</code>.</p>
|
||
<p>The current position is advanced by 1.</p>
|
||
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x08 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">8</span>, <span class="ident">buf</span>.<span class="ident">get_u8</span>());</pre></div>
|
||
<h1 id="panics-2" class="section-header"><a href="#panics-2">Panics</a></h1>
|
||
<p>This function panics if there is no more remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_i8' class='method'><code id='get_i8.v'>fn <a href='#method.get_i8' class='fnname'>get_i8</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code></h3><div class='docblock'><p>Gets a signed 8 bit integer from <code>self</code>.</p>
|
||
<p>The current position is advanced by 1.</p>
|
||
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x08 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">8</span>, <span class="ident">buf</span>.<span class="ident">get_i8</span>());</pre></div>
|
||
<h1 id="panics-3" class="section-header"><a href="#panics-3">Panics</a></h1>
|
||
<p>This function panics if there is no more remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_u16_be' class='method'><code id='get_u16_be.v'>fn <a href='#method.get_u16_be' class='fnname'>get_u16_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code></h3><div class='docblock'><p>Gets an unsigned 16 bit integer from <code>self</code> in big-endian byte order.</p>
|
||
<p>The current position is advanced by 2.</p>
|
||
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x08\x09 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x0809</span>, <span class="ident">buf</span>.<span class="ident">get_u16_be</span>());</pre></div>
|
||
<h1 id="panics-4" class="section-header"><a href="#panics-4">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_u16_le' class='method'><code id='get_u16_le.v'>fn <a href='#method.get_u16_le' class='fnname'>get_u16_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code></h3><div class='docblock'><p>Gets an unsigned 16 bit integer from <code>self</code> in little-endian byte order.</p>
|
||
<p>The current position is advanced by 2.</p>
|
||
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x09\x08 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x0809</span>, <span class="ident">buf</span>.<span class="ident">get_u16_le</span>());</pre></div>
|
||
<h1 id="panics-5" class="section-header"><a href="#panics-5">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_i16_be' class='method'><code id='get_i16_be.v'>fn <a href='#method.get_i16_be' class='fnname'>get_i16_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></code></h3><div class='docblock'><p>Gets a signed 16 bit integer from <code>self</code> in big-endian byte order.</p>
|
||
<p>The current position is advanced by 2.</p>
|
||
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x08\x09 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x0809</span>, <span class="ident">buf</span>.<span class="ident">get_i16_be</span>());</pre></div>
|
||
<h1 id="panics-6" class="section-header"><a href="#panics-6">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_i16_le' class='method'><code id='get_i16_le.v'>fn <a href='#method.get_i16_le' class='fnname'>get_i16_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></code></h3><div class='docblock'><p>Gets a signed 16 bit integer from <code>self</code> in little-endian byte order.</p>
|
||
<p>The current position is advanced by 2.</p>
|
||
<h1 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x09\x08 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x0809</span>, <span class="ident">buf</span>.<span class="ident">get_i16_le</span>());</pre></div>
|
||
<h1 id="panics-7" class="section-header"><a href="#panics-7">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_u32_be' class='method'><code id='get_u32_be.v'>fn <a href='#method.get_u32_be' class='fnname'>get_u32_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></h3><div class='docblock'><p>Gets an unsigned 32 bit integer from <code>self</code> in the big-endian byte order.</p>
|
||
<p>The current position is advanced by 4.</p>
|
||
<h1 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x08\x09\xA0\xA1 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x0809A0A1</span>, <span class="ident">buf</span>.<span class="ident">get_u32_be</span>());</pre></div>
|
||
<h1 id="panics-8" class="section-header"><a href="#panics-8">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_u32_le' class='method'><code id='get_u32_le.v'>fn <a href='#method.get_u32_le' class='fnname'>get_u32_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></h3><div class='docblock'><p>Gets an unsigned 32 bit integer from <code>self</code> in the little-endian byte order.</p>
|
||
<p>The current position is advanced by 4.</p>
|
||
<h1 id="examples-12" class="section-header"><a href="#examples-12">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\xA1\xA0\x09\x08 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x0809A0A1</span>, <span class="ident">buf</span>.<span class="ident">get_u32_le</span>());</pre></div>
|
||
<h1 id="panics-9" class="section-header"><a href="#panics-9">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_i32_be' class='method'><code id='get_i32_be.v'>fn <a href='#method.get_i32_be' class='fnname'>get_i32_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code></h3><div class='docblock'><p>Gets a signed 32 bit integer from <code>self</code> in big-endian byte order.</p>
|
||
<p>The current position is advanced by 4.</p>
|
||
<h1 id="examples-13" class="section-header"><a href="#examples-13">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x08\x09\xA0\xA1 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x0809A0A1</span>, <span class="ident">buf</span>.<span class="ident">get_i32_be</span>());</pre></div>
|
||
<h1 id="panics-10" class="section-header"><a href="#panics-10">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_i32_le' class='method'><code id='get_i32_le.v'>fn <a href='#method.get_i32_le' class='fnname'>get_i32_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code></h3><div class='docblock'><p>Gets a signed 32 bit integer from <code>self</code> in little-endian byte order.</p>
|
||
<p>The current position is advanced by 4.</p>
|
||
<h1 id="examples-14" class="section-header"><a href="#examples-14">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\xA1\xA0\x09\x08 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x0809A0A1</span>, <span class="ident">buf</span>.<span class="ident">get_i32_le</span>());</pre></div>
|
||
<h1 id="panics-11" class="section-header"><a href="#panics-11">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_u64_be' class='method'><code id='get_u64_be.v'>fn <a href='#method.get_u64_be' class='fnname'>get_u64_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></h3><div class='docblock'><p>Gets an unsigned 64 bit integer from <code>self</code> in big-endian byte order.</p>
|
||
<p>The current position is advanced by 8.</p>
|
||
<h1 id="examples-15" class="section-header"><a href="#examples-15">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x01\x02\x03\x04\x05\x06\x07\x08 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x0102030405060708</span>, <span class="ident">buf</span>.<span class="ident">get_u64_be</span>());</pre></div>
|
||
<h1 id="panics-12" class="section-header"><a href="#panics-12">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_u64_le' class='method'><code id='get_u64_le.v'>fn <a href='#method.get_u64_le' class='fnname'>get_u64_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></h3><div class='docblock'><p>Gets an unsigned 64 bit integer from <code>self</code> in little-endian byte order.</p>
|
||
<p>The current position is advanced by 8.</p>
|
||
<h1 id="examples-16" class="section-header"><a href="#examples-16">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x08\x07\x06\x05\x04\x03\x02\x01 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x0102030405060708</span>, <span class="ident">buf</span>.<span class="ident">get_u64_le</span>());</pre></div>
|
||
<h1 id="panics-13" class="section-header"><a href="#panics-13">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_i64_be' class='method'><code id='get_i64_be.v'>fn <a href='#method.get_i64_be' class='fnname'>get_i64_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code></h3><div class='docblock'><p>Gets a signed 64 bit integer from <code>self</code> in big-endian byte order.</p>
|
||
<p>The current position is advanced by 8.</p>
|
||
<h1 id="examples-17" class="section-header"><a href="#examples-17">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x01\x02\x03\x04\x05\x06\x07\x08 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x0102030405060708</span>, <span class="ident">buf</span>.<span class="ident">get_i64_be</span>());</pre></div>
|
||
<h1 id="panics-14" class="section-header"><a href="#panics-14">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_i64_le' class='method'><code id='get_i64_le.v'>fn <a href='#method.get_i64_le' class='fnname'>get_i64_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code></h3><div class='docblock'><p>Gets a signed 64 bit integer from <code>self</code> in little-endian byte order.</p>
|
||
<p>The current position is advanced by 8.</p>
|
||
<h1 id="examples-18" class="section-header"><a href="#examples-18">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x08\x07\x06\x05\x04\x03\x02\x01 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x0102030405060708</span>, <span class="ident">buf</span>.<span class="ident">get_i64_le</span>());</pre></div>
|
||
<h1 id="panics-15" class="section-header"><a href="#panics-15">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_uint_be' class='method'><code id='get_uint_be.v'>fn <a href='#method.get_uint_be' class='fnname'>get_uint_be</a>(&mut self, nbytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></h3><div class='docblock'><p>Gets an unsigned n-byte integer from <code>self</code> in big-endian byte order.</p>
|
||
<p>The current position is advanced by <code>nbytes</code>.</p>
|
||
<h1 id="examples-19" class="section-header"><a href="#examples-19">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::{<span class="ident">Buf</span>, <span class="ident">BigEndian</span>};
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x01\x02\x03 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x010203</span>, <span class="ident">buf</span>.<span class="ident">get_uint_be</span>(<span class="number">3</span>));</pre></div>
|
||
<h1 id="panics-16" class="section-header"><a href="#panics-16">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_uint_le' class='method'><code id='get_uint_le.v'>fn <a href='#method.get_uint_le' class='fnname'>get_uint_le</a>(&mut self, nbytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></h3><div class='docblock'><p>Gets an unsigned n-byte integer from <code>self</code> in little-endian byte order.</p>
|
||
<p>The current position is advanced by <code>nbytes</code>.</p>
|
||
<h1 id="examples-20" class="section-header"><a href="#examples-20">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x03\x02\x01 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x010203</span>, <span class="ident">buf</span>.<span class="ident">get_uint_le</span>(<span class="number">3</span>));</pre></div>
|
||
<h1 id="panics-17" class="section-header"><a href="#panics-17">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_int_be' class='method'><code id='get_int_be.v'>fn <a href='#method.get_int_be' class='fnname'>get_int_be</a>(&mut self, nbytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code></h3><div class='docblock'><p>Gets a signed n-byte integer from <code>self</code> in big-endian byte order.</p>
|
||
<p>The current position is advanced by <code>nbytes</code>.</p>
|
||
<h1 id="examples-21" class="section-header"><a href="#examples-21">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x01\x02\x03 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x010203</span>, <span class="ident">buf</span>.<span class="ident">get_int_be</span>(<span class="number">3</span>));</pre></div>
|
||
<h1 id="panics-18" class="section-header"><a href="#panics-18">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_int_le' class='method'><code id='get_int_le.v'>fn <a href='#method.get_int_le' class='fnname'>get_int_le</a>(&mut self, nbytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code></h3><div class='docblock'><p>Gets a signed n-byte integer from <code>self</code> in little-endian byte order.</p>
|
||
<p>The current position is advanced by <code>nbytes</code>.</p>
|
||
<h1 id="examples-22" class="section-header"><a href="#examples-22">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x03\x02\x01 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x010203</span>, <span class="ident">buf</span>.<span class="ident">get_int_le</span>(<span class="number">3</span>));</pre></div>
|
||
<h1 id="panics-19" class="section-header"><a href="#panics-19">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_f32_be' class='method'><code id='get_f32_be.v'>fn <a href='#method.get_f32_be' class='fnname'>get_f32_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code></h3><div class='docblock'><p>Gets an IEEE754 single-precision (4 bytes) floating point number from
|
||
<code>self</code> in big-endian byte order.</p>
|
||
<p>The current position is advanced by 4.</p>
|
||
<h1 id="examples-23" class="section-header"><a href="#examples-23">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x3F\x99\x99\x9A hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">1.2f32</span>, <span class="ident">buf</span>.<span class="ident">get_f32_be</span>());</pre></div>
|
||
<h1 id="panics-20" class="section-header"><a href="#panics-20">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_f32_le' class='method'><code id='get_f32_le.v'>fn <a href='#method.get_f32_le' class='fnname'>get_f32_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code></h3><div class='docblock'><p>Gets an IEEE754 single-precision (4 bytes) floating point number from
|
||
<code>self</code> in little-endian byte order.</p>
|
||
<p>The current position is advanced by 4.</p>
|
||
<h1 id="examples-24" class="section-header"><a href="#examples-24">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x9A\x99\x99\x3F hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">1.2f32</span>, <span class="ident">buf</span>.<span class="ident">get_f32_le</span>());</pre></div>
|
||
<h1 id="panics-21" class="section-header"><a href="#panics-21">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_f64_be' class='method'><code id='get_f64_be.v'>fn <a href='#method.get_f64_be' class='fnname'>get_f64_be</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code></h3><div class='docblock'><p>Gets an IEEE754 double-precision (8 bytes) floating point number from
|
||
<code>self</code> in big-endian byte order.</p>
|
||
<p>The current position is advanced by 8.</p>
|
||
<h1 id="examples-25" class="section-header"><a href="#examples-25">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x3F\xF3\x33\x33\x33\x33\x33\x33 hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">1.2f64</span>, <span class="ident">buf</span>.<span class="ident">get_f64_be</span>());</pre></div>
|
||
<h1 id="panics-22" class="section-header"><a href="#panics-22">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.get_f64_le' class='method'><code id='get_f64_le.v'>fn <a href='#method.get_f64_le' class='fnname'>get_f64_le</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code></h3><div class='docblock'><p>Gets an IEEE754 double-precision (8 bytes) floating point number from
|
||
<code>self</code> in little-endian byte order.</p>
|
||
<p>The current position is advanced by 8.</p>
|
||
<h1 id="examples-26" class="section-header"><a href="#examples-26">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Buf</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">b"\x33\x33\x33\x33\x33\x33\xF3\x3F hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">1.2f64</span>, <span class="ident">buf</span>.<span class="ident">get_f64_le</span>());</pre></div>
|
||
<h1 id="panics-23" class="section-header"><a href="#panics-23">Panics</a></h1>
|
||
<p>This function panics if there is not enough remaining data in <code>self</code>.</p>
|
||
</div><h3 id='method.collect' class='method'><code id='collect.v'>fn <a href='#method.collect' class='fnname'>collect</a><B>(self) -> B <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> B: <a class="trait" href="../bytes/buf/trait.FromBuf.html" title="trait bytes::buf::FromBuf">FromBuf</a>, </span></code></h3><div class='docblock'><p>Transforms a <code>Buf</code> into a concrete buffer.</p>
|
||
<p><code>collect()</code> can operate on any value that implements <code>Buf</code>, and turn it
|
||
into the relevent concrete buffer type.</p>
|
||
<h1 id="examples-27" class="section-header"><a href="#examples-27">Examples</a></h1>
|
||
<p>Collecting a buffer and loading the contents into a <code>Vec<u8></code>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::{<span class="ident">Buf</span>, <span class="ident">Bytes</span>, <span class="ident">IntoBuf</span>};
|
||
|
||
<span class="kw">let</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Bytes</span>::<span class="ident">from</span>(<span class="kw-2">&</span><span class="string">b"hello world"</span>[..]).<span class="ident">into_buf</span>();
|
||
<span class="kw">let</span> <span class="ident">vec</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">collect</span>();
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">vec</span>, <span class="kw-2">&</span><span class="string">b"hello world"</span>[..]);</pre></div>
|
||
</div><h3 id='method.take' class='method'><code id='take.v'>fn <a href='#method.take' class='fnname'>take</a>(self, limit: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../bytes/buf/struct.Take.html" title="struct bytes::buf::Take">Take</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><div class='docblock'><p>Creates an adaptor which will read at most <code>limit</code> bytes from <code>self</code>.</p>
|
||
<p>This function returns a new instance of <code>Buf</code> which will read at most
|
||
<code>limit</code> bytes.</p>
|
||
<h1 id="examples-28" class="section-header"><a href="#examples-28">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::{<span class="ident">Buf</span>, <span class="ident">BufMut</span>};
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">"hello world"</span>).<span class="ident">take</span>(<span class="number">5</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">dst</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[];
|
||
|
||
<span class="ident">dst</span>.<span class="ident">put</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">dst</span>, <span class="string">b"hello"</span>);
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">into_inner</span>();
|
||
<span class="ident">dst</span>.<span class="ident">clear</span>();
|
||
<span class="ident">dst</span>.<span class="ident">put</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">dst</span>, <span class="string">b" world"</span>);</pre></div>
|
||
</div><h3 id='method.chain' class='method'><code id='chain.v'>fn <a href='#method.chain' class='fnname'>chain</a><U>(self, next: U) -> <a class="struct" href="../bytes/buf/struct.Chain.html" title="struct bytes::buf::Chain">Chain</a><Self, U::<a class="type" href="../bytes/buf/trait.IntoBuf.html#associatedtype.Buf" title="type bytes::buf::IntoBuf::Buf">Buf</a>> <span class="where fmt-newline">where<br> U: <a class="trait" href="../bytes/buf/trait.IntoBuf.html" title="trait bytes::buf::IntoBuf">IntoBuf</a>,<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><div class='docblock'><p>Creates an adaptor which will chain this buffer with another.</p>
|
||
<p>The returned <code>Buf</code> instance will first consume all bytes from <code>self</code>.
|
||
Afterwards the output is equivalent to the output of next.</p>
|
||
<h1 id="examples-29" class="section-header"><a href="#examples-29">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::{<span class="ident">Bytes</span>, <span class="ident">Buf</span>, <span class="ident">IntoBuf</span>};
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">buf</span>::<span class="ident">Chain</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Bytes</span>::<span class="ident">from</span>(<span class="kw-2">&</span><span class="string">b"hello "</span>[..]).<span class="ident">into_buf</span>()
|
||
.<span class="ident">chain</span>(<span class="ident">Bytes</span>::<span class="ident">from</span>(<span class="kw-2">&</span><span class="string">b"world"</span>[..]));
|
||
|
||
<span class="kw">let</span> <span class="ident">full</span>: <span class="ident">Bytes</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">collect</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">full</span>[..], <span class="string">b"hello world"</span>[..]);</pre></div>
|
||
</div><h3 id='method.by_ref' class='method'><code id='by_ref.v'>fn <a href='#method.by_ref' class='fnname'>by_ref</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><div class='docblock'><p>Creates a "by reference" adaptor for this instance of <code>Buf</code>.</p>
|
||
<p>The returned adaptor also implements <code>Buf</code> and will simply borrow <code>self</code>.</p>
|
||
<h1 id="examples-30" class="section-header"><a href="#examples-30">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::{<span class="ident">Buf</span>, <span class="ident">BufMut</span>};
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="string">"hello world"</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">dst</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[];
|
||
|
||
{
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">reference</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">by_ref</span>();
|
||
<span class="ident">dst</span>.<span class="ident">put</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">reference</span>.<span class="ident">take</span>(<span class="number">5</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">dst</span>, <span class="string">b"hello"</span>);
|
||
} <span class="comment">// drop our &mut reference so we can use `buf` again</span>
|
||
|
||
<span class="ident">dst</span>.<span class="ident">clear</span>();
|
||
<span class="ident">dst</span>.<span class="ident">put</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">dst</span>, <span class="string">b" world"</span>);</pre></div>
|
||
</div><h3 id='method.reader' class='method'><code id='reader.v'>fn <a href='#method.reader' class='fnname'>reader</a>(self) -> <a class="struct" href="../bytes/buf/struct.Reader.html" title="struct bytes::buf::Reader">Reader</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><div class='docblock'><p>Creates an adaptor which implements the <code>Read</code> trait for <code>self</code>.</p>
|
||
<p>This function returns a new value which implements <code>Read</code> by adapting
|
||
the <code>Read</code> trait functions to the <code>Buf</code> trait functions. Given that
|
||
<code>Buf</code> operations are infallible, none of the <code>Read</code> functions will
|
||
return with <code>Err</code>.</p>
|
||
<h1 id="examples-31" class="section-header"><a href="#examples-31">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::{<span class="ident">Buf</span>, <span class="ident">IntoBuf</span>, <span class="ident">Bytes</span>};
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Read</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Bytes</span>::<span class="ident">from</span>(<span class="string">"hello world"</span>).<span class="ident">into_buf</span>();
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">reader</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">reader</span>();
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">dst</span> <span class="op">=</span> [<span class="number">0</span>; <span class="number">1024</span>];
|
||
|
||
<span class="kw">let</span> <span class="ident">num</span> <span class="op">=</span> <span class="ident">reader</span>.<span class="ident">read</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">dst</span>).<span class="ident">unwrap</span>();
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">11</span>, <span class="ident">num</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="ident">dst</span>[..<span class="number">11</span>], <span class="string">b"hello world"</span>);</pre></div>
|
||
</div><h3 id='method.iter' class='method'><code id='iter.v'>fn <a href='#method.iter' class='fnname'>iter</a>(self) -> <a class="struct" href="../bytes/buf/struct.Iter.html" title="struct bytes::buf::Iter">Iter</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><div class='docblock'><p>Returns an iterator over the bytes contained by the buffer.</p>
|
||
<h1 id="examples-32" class="section-header"><a href="#examples-32">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">bytes</span>::{<span class="ident">Buf</span>, <span class="ident">IntoBuf</span>, <span class="ident">Bytes</span>};
|
||
|
||
<span class="kw">let</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Bytes</span>::<span class="ident">from</span>(<span class="kw-2">&</span><span class="string">b"abc"</span>[..]).<span class="ident">into_buf</span>();
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">iter</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">iter</span>();
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iter</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="string">b'a'</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iter</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="string">b'b'</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iter</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="string">b'c'</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iter</span>.<span class="ident">next</span>(), <span class="prelude-val">None</span>);</pre></div>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-Buf-for-%26%27a%20mut%20T' class='impl'><code class='in-band'>impl<'a, T: <a class="trait" href="../bytes/buf/trait.Buf.html" title="trait bytes::buf::Buf">Buf</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="../bytes/buf/trait.Buf.html" title="trait bytes::buf::Buf">Buf</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>T</code><a href='#impl-Buf-for-%26%27a%20mut%20T' class='anchor'></a><a class='srclink' href='../src/bytes/buf/buf.rs.html#1055-1071' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.remaining' class="method hidden"><code id='remaining.v-1'>fn <a href='#method.remaining' class='fnname'>remaining</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/bytes/buf/buf.rs.html#1056-1058' title='goto source code'>[src]</a></h4><h4 id='method.bytes' class="method hidden"><code id='bytes.v-1'>fn <a href='#method.bytes' class='fnname'>bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a class='srclink' href='../src/bytes/buf/buf.rs.html#1060-1062' title='goto source code'>[src]</a></h4><h4 id='method.bytes_vec-1' class="method hidden"><code id='bytes_vec.v-1'>fn <a href='#method.bytes_vec' class='fnname'>bytes_vec</a><'b>(&'b self, dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a>&'b <a class="struct" href="../iovec/struct.IoVec.html" title="struct iovec::IoVec">IoVec</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/bytes/buf/buf.rs.html#1064-1066' title='goto source code'>[src]</a></h4><h4 id='method.advance' class="method hidden"><code id='advance.v-1'>fn <a href='#method.advance' class='fnname'>advance</a>(&mut self, cnt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code><a class='srclink' href='../src/bytes/buf/buf.rs.html#1068-1070' title='goto source code'>[src]</a></h4></div><h3 id='impl-Buf-for-Box%3CT%3E' class='impl'><code class='in-band'>impl<T: <a class="trait" href="../bytes/buf/trait.Buf.html" title="trait bytes::buf::Buf">Buf</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="../bytes/buf/trait.Buf.html" title="trait bytes::buf::Buf">Buf</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T></code><a href='#impl-Buf-for-Box%3CT%3E' class='anchor'></a><a class='srclink' href='../src/bytes/buf/buf.rs.html#1073-1089' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.remaining-1' class="method hidden"><code id='remaining.v-2'>fn <a href='#method.remaining' class='fnname'>remaining</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/bytes/buf/buf.rs.html#1074-1076' title='goto source code'>[src]</a></h4><h4 id='method.bytes-1' class="method hidden"><code id='bytes.v-2'>fn <a href='#method.bytes' class='fnname'>bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a class='srclink' href='../src/bytes/buf/buf.rs.html#1078-1080' title='goto source code'>[src]</a></h4><h4 id='method.bytes_vec-2' class="method hidden"><code id='bytes_vec.v-2'>fn <a href='#method.bytes_vec' class='fnname'>bytes_vec</a><'b>(&'b self, dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a>&'b <a class="struct" href="../iovec/struct.IoVec.html" title="struct iovec::IoVec">IoVec</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/bytes/buf/buf.rs.html#1082-1084' title='goto source code'>[src]</a></h4><h4 id='method.advance-1' class="method hidden"><code id='advance.v-2'>fn <a href='#method.advance' class='fnname'>advance</a>(&mut self, cnt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code><a class='srclink' href='../src/bytes/buf/buf.rs.html#1086-1088' title='goto source code'>[src]</a></h4></div><h3 id='impl-Buf-for-Cursor%3CT%3E' class='impl'><code class='in-band'>impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>> <a class="trait" href="../bytes/buf/trait.Buf.html" title="trait bytes::buf::Buf">Buf</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/cursor/struct.Cursor.html" title="struct std::io::cursor::Cursor">Cursor</a><T></code><a href='#impl-Buf-for-Cursor%3CT%3E' class='anchor'></a><a class='srclink' href='../src/bytes/buf/buf.rs.html#1091-1122' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.remaining-2' class="method hidden"><code id='remaining.v-3'>fn <a href='#method.remaining' class='fnname'>remaining</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/bytes/buf/buf.rs.html#1092-1101' title='goto source code'>[src]</a></h4><h4 id='method.bytes-2' class="method hidden"><code id='bytes.v-3'>fn <a href='#method.bytes' class='fnname'>bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a class='srclink' href='../src/bytes/buf/buf.rs.html#1103-1112' title='goto source code'>[src]</a></h4><h4 id='method.advance-2' class="method hidden"><code id='advance.v-3'>fn <a href='#method.advance' class='fnname'>advance</a>(&mut self, cnt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code><a class='srclink' href='../src/bytes/buf/buf.rs.html#1114-1121' title='goto source code'>[src]</a></h4></div><h3 id='impl-Buf-for-Option%3C%5Bu8%3B%201%5D%3E' class='impl'><code class='in-band'>impl <a class="trait" href="../bytes/buf/trait.Buf.html" title="trait bytes::buf::Buf">Buf</a> for <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 1]</a>></code><a href='#impl-Buf-for-Option%3C%5Bu8%3B%201%5D%3E' class='anchor'></a><a class='srclink' href='../src/bytes/buf/buf.rs.html#1124-1150' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.remaining-3' class="method hidden"><code id='remaining.v-4'>fn <a href='#method.remaining' class='fnname'>remaining</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/bytes/buf/buf.rs.html#1125-1131' title='goto source code'>[src]</a></h4><h4 id='method.bytes-3' class="method hidden"><code id='bytes.v-4'>fn <a href='#method.bytes' class='fnname'>bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a class='srclink' href='../src/bytes/buf/buf.rs.html#1133-1136' title='goto source code'>[src]</a></h4><h4 id='method.advance-3' class="method hidden"><code id='advance.v-4'>fn <a href='#method.advance' class='fnname'>advance</a>(&mut self, cnt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code><a class='srclink' href='../src/bytes/buf/buf.rs.html#1138-1149' title='goto source code'>[src]</a></h4></div><h3 id='impl-Buf-for-VecDeque%3Cu8%3E' class='impl'><code class='in-band'>impl <a class="trait" href="../bytes/buf/trait.Buf.html" title="trait bytes::buf::Buf">Buf</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/collections/vec_deque/struct.VecDeque.html" title="struct alloc::collections::vec_deque::VecDeque">VecDeque</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></code><a href='#impl-Buf-for-VecDeque%3Cu8%3E' class='anchor'></a><a class='srclink' href='../src/bytes/buf/vec_deque.rs.html#5-22' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.remaining-4' class="method hidden"><code id='remaining.v-5'>fn <a href='#method.remaining' class='fnname'>remaining</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/bytes/buf/vec_deque.rs.html#6-8' title='goto source code'>[src]</a></h4><h4 id='method.bytes-4' class="method hidden"><code id='bytes.v-5'>fn <a href='#method.bytes' class='fnname'>bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a class='srclink' href='../src/bytes/buf/vec_deque.rs.html#10-17' title='goto source code'>[src]</a></h4><h4 id='method.advance-4' class="method hidden"><code id='advance.v-5'>fn <a href='#method.advance' class='fnname'>advance</a>(&mut self, cnt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code><a class='srclink' href='../src/bytes/buf/vec_deque.rs.html#19-21' title='goto source code'>[src]</a></h4></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-Buf' class='impl'><code class='in-band'>impl<T, U> Buf for <a class="struct" href="../bytes/buf/struct.Chain.html" title="struct bytes::buf::Chain">Chain</a><T, U> <span class="where fmt-newline">where<br> T: <a class="trait" href="../bytes/buf/trait.Buf.html" title="trait bytes::buf::Buf">Buf</a>,<br> U: <a class="trait" href="../bytes/buf/trait.Buf.html" title="trait bytes::buf::Buf">Buf</a>, </span></code><a href='#impl-Buf' class='anchor'></a><a class='srclink' href='../src/bytes/buf/chain.rs.html#146-185' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.remaining-5' class="method hidden"><code id='remaining.v-6'>fn <a href='#method.remaining-5' class='fnname'>remaining</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/bytes/buf/chain.rs.html#150-152' title='goto source code'>[src]</a></h4><h4 id='method.bytes-5' class="method hidden"><code id='bytes.v-6'>fn <a href='#method.bytes-5' class='fnname'>bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a class='srclink' href='../src/bytes/buf/chain.rs.html#154-160' title='goto source code'>[src]</a></h4><h4 id='method.advance-5' class="method hidden"><code id='advance.v-6'>fn <a href='#method.advance-5' class='fnname'>advance</a>(&mut self, cnt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code><a class='srclink' href='../src/bytes/buf/chain.rs.html#162-178' title='goto source code'>[src]</a></h4><h4 id='method.bytes_vec-3' class="method hidden"><code id='bytes_vec.v-3'>fn <a href='#method.bytes_vec-3' class='fnname'>bytes_vec</a><'a>(&'a self, dst: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a>&'a <a class="struct" href="../iovec/struct.IoVec.html" title="struct iovec::IoVec">IoVec</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/bytes/buf/chain.rs.html#180-184' title='goto source code'>[src]</a></h4></div><h3 id='impl-Buf-1' class='impl'><code class='in-band'>impl<T: <a class="trait" href="../bytes/buf/trait.Buf.html" title="trait bytes::buf::Buf">Buf</a>> Buf for <a class="struct" href="../bytes/buf/struct.Take.html" title="struct bytes::buf::Take">Take</a><T></code><a href='#impl-Buf-1' class='anchor'></a><a class='srclink' href='../src/bytes/buf/take.rs.html#140-155' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.remaining-6' class="method hidden"><code id='remaining.v-7'>fn <a href='#method.remaining-6' class='fnname'>remaining</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/bytes/buf/take.rs.html#141-143' title='goto source code'>[src]</a></h4><h4 id='method.bytes-6' class="method hidden"><code id='bytes.v-7'>fn <a href='#method.bytes-6' class='fnname'>bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a class='srclink' href='../src/bytes/buf/take.rs.html#145-148' title='goto source code'>[src]</a></h4><h4 id='method.advance-6' class="method hidden"><code id='advance.v-7'>fn <a href='#method.advance-6' class='fnname'>advance</a>(&mut self, cnt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code><a class='srclink' href='../src/bytes/buf/take.rs.html#150-154' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript" src="../implementors/bytes/trait.Buf.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "bytes";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |