11 lines
5.8 KiB
HTML
11 lines
5.8 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="Utilities for working with buffers."><title>bytes::buf - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bytes" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module buf</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bytes/index.html">bytes</a><span class="version">1.11.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module buf</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#buf-bufmut" title="`Buf`, `BufMut`"><code>Buf</code>, <code>BufMut</code></a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate bytes</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">bytes</a></div><h1>Module <span>buf</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/bytes/buf/mod.rs.html#1-39">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Utilities for working with buffers.</p>
|
|
<p>A buffer is any structure that contains a sequence of bytes. The bytes may
|
|
or may not be stored in contiguous memory. This module contains traits used
|
|
to abstract over buffers as well as utilities for working with buffer types.</p>
|
|
<h2 id="buf-bufmut"><a class="doc-anchor" href="#buf-bufmut">§</a><code>Buf</code>, <code>BufMut</code></h2>
|
|
<p>These are the two foundational traits for abstractly working with buffers.
|
|
They can be thought as iterators for byte structures. They offer additional
|
|
performance over <code>Iterator</code> by providing an API optimized for byte slices.</p>
|
|
<p>See <a href="trait.Buf.html" title="trait bytes::buf::Buf"><code>Buf</code></a> and <a href="trait.BufMut.html" title="trait bytes::buf::BufMut"><code>BufMut</code></a> for more details.</p>
|
|
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Chain.html" title="struct bytes::buf::Chain">Chain</a></dt><dd>A <code>Chain</code> sequences two buffers.</dd><dt><a class="struct" href="struct.IntoIter.html" title="struct bytes::buf::IntoIter">Into<wbr>Iter</a></dt><dd>Iterator over the bytes contained by the buffer.</dd><dt><a class="struct" href="struct.Limit.html" title="struct bytes::buf::Limit">Limit</a></dt><dd>A <code>BufMut</code> adapter which limits the amount of bytes that can be written
|
|
to an underlying buffer.</dd><dt><a class="struct" href="struct.Reader.html" title="struct bytes::buf::Reader">Reader</a></dt><dd>A <code>Buf</code> adapter which implements <code>io::Read</code> for the inner value.</dd><dt><a class="struct" href="struct.Take.html" title="struct bytes::buf::Take">Take</a></dt><dd>A <code>Buf</code> adapter which limits the bytes read from an underlying buffer.</dd><dt><a class="struct" href="struct.UninitSlice.html" title="struct bytes::buf::UninitSlice">Uninit<wbr>Slice</a></dt><dd>Uninitialized byte slice.</dd><dt><a class="struct" href="struct.Writer.html" title="struct bytes::buf::Writer">Writer</a></dt><dd>A <code>BufMut</code> adapter which implements <code>io::Write</code> for the inner value.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.Buf.html" title="trait bytes::buf::Buf">Buf</a></dt><dd>Read bytes from a buffer.</dd><dt><a class="trait" href="trait.BufMut.html" title="trait bytes::buf::BufMut">BufMut</a></dt><dd>A trait for values that provide sequential write access to bytes.</dd></dl></section></div></main></body></html> |