| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/bytes-1.4.0/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../bytes/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../bytes/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| </pre><pre class="rust"><code><span class="attribute">#![warn(missing_docs, missing_debug_implementations, rust_2018_idioms)] |
| #![doc(test( |
| no_crate_inject, |
| attr(deny(warnings, rust_2018_idioms), allow(dead_code, unused_variables)) |
| ))] |
| #![no_std] |
| #![cfg_attr(docsrs, feature(doc_cfg))] |
| |
| </span><span class="doccomment">//! Provides abstractions for working with bytes. |
| //! |
| //! The `bytes` crate provides an efficient byte buffer structure |
| //! ([`Bytes`](struct.Bytes.html)) and traits for working with buffer |
| //! implementations ([`Buf`], [`BufMut`]). |
| //! |
| //! [`Buf`]: trait.Buf.html |
| //! [`BufMut`]: trait.BufMut.html |
| //! |
| //! # `Bytes` |
| //! |
| //! `Bytes` is an efficient container for storing and operating on contiguous |
| //! slices of memory. It is intended for use primarily in networking code, but |
| //! could have applications elsewhere as well. |
| //! |
| //! `Bytes` values facilitate zero-copy network programming by allowing multiple |
| //! `Bytes` objects to point to the same underlying memory. This is managed by |
| //! using a reference count to track when the memory is no longer needed and can |
| //! be freed. |
| //! |
| //! A `Bytes` handle can be created directly from an existing byte store (such as `&[u8]` |
| //! or `Vec<u8>`), but usually a `BytesMut` is used first and written to. For |
| //! example: |
| //! |
| //! ```rust |
| //! use bytes::{BytesMut, BufMut}; |
| //! |
| //! let mut buf = BytesMut::with_capacity(1024); |
| //! buf.put(&b"hello world"[..]); |
| //! buf.put_u16(1234); |
| //! |
| //! let a = buf.split(); |
| //! assert_eq!(a, b"hello world\x04\xD2"[..]); |
| //! |
| //! buf.put(&b"goodbye world"[..]); |
| //! |
| //! let b = buf.split(); |
| //! assert_eq!(b, b"goodbye world"[..]); |
| //! |
| //! assert_eq!(buf.capacity(), 998); |
| //! ``` |
| //! |
| //! In the above example, only a single buffer of 1024 is allocated. The handles |
| //! `a` and `b` will share the underlying buffer and maintain indices tracking |
| //! the view into the buffer represented by the handle. |
| //! |
| //! See the [struct docs] for more details. |
| //! |
| //! [struct docs]: struct.Bytes.html |
| //! |
| //! # `Buf`, `BufMut` |
| //! |
| //! These two traits provide read and write access to buffers. The underlying |
| //! storage may or may not be in contiguous memory. For example, `Bytes` is a |
| //! buffer that guarantees contiguous memory, but a [rope] stores the bytes in |
| //! disjoint chunks. `Buf` and `BufMut` maintain cursors tracking the current |
| //! position in the underlying byte storage. When bytes are read or written, the |
| //! cursor is advanced. |
| //! |
| //! [rope]: https://en.wikipedia.org/wiki/Rope_(data_structure) |
| //! |
| //! ## Relation with `Read` and `Write` |
| //! |
| //! At first glance, it may seem that `Buf` and `BufMut` overlap in |
| //! functionality with `std::io::Read` and `std::io::Write`. However, they |
| //! serve different purposes. A buffer is the value that is provided as an |
| //! argument to `Read::read` and `Write::write`. `Read` and `Write` may then |
| //! perform a syscall, which has the potential of failing. Operations on `Buf` |
| //! and `BufMut` are infallible. |
| |
| </span><span class="kw">extern crate </span>alloc; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">extern crate </span>std; |
| |
| <span class="kw">pub mod </span>buf; |
| <span class="kw">pub use </span><span class="kw">crate</span>::buf::{Buf, BufMut}; |
| |
| <span class="kw">mod </span>bytes; |
| <span class="kw">mod </span>bytes_mut; |
| <span class="kw">mod </span>fmt; |
| <span class="kw">mod </span>loom; |
| <span class="kw">pub use </span><span class="kw">crate</span>::bytes::Bytes; |
| <span class="kw">pub use </span><span class="kw">crate</span>::bytes_mut::BytesMut; |
| |
| <span class="comment">// Optional Serde support |
| </span><span class="attribute">#[cfg(feature = <span class="string">"serde"</span>)] |
| </span><span class="kw">mod </span>serde; |
| |
| <span class="attribute">#[inline(never)] |
| #[cold] |
| </span><span class="kw">fn </span>abort() -> ! { |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span>{ |
| std::process::abort(); |
| } |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"std"</span>))] |
| </span>{ |
| <span class="kw">struct </span>Abort; |
| <span class="kw">impl </span>Drop <span class="kw">for </span>Abort { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="macro">panic!</span>(); |
| } |
| } |
| <span class="kw">let </span>_a = Abort; |
| <span class="macro">panic!</span>(<span class="string">"abort"</span>); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="bytes" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
