mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-26 19:58:50 +01:00
12 lines
6.9 KiB
HTML
12 lines
6.9 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><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bytes/index.html">bytes</a><span class="version">1.5.0</span></h2></div><h2 class="location"><a href="#">Module buf</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></section><h2><a href="../index.html">In crate bytes</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../bytes/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">bytes</a>::<wbr><a class="mod" href="#">buf</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/bytes/buf/mod.rs.html#1-41">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></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 href="#buf-bufmut"><code>Buf</code>, <code>BufMut</code></a></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"><code>Buf</code></a> and <a href="trait.BufMut.html"><code>BufMut</code></a> for more details.</p>
|
||
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Chain.html" title="struct bytes::buf::Chain">Chain</a></div><div class="desc docblock-short">A <code>Chain</code> sequences two buffers.</div></li><li><div class="item-name"><a class="struct" href="struct.IntoIter.html" title="struct bytes::buf::IntoIter">IntoIter</a></div><div class="desc docblock-short">Iterator over the bytes contained by the buffer.</div></li><li><div class="item-name"><a class="struct" href="struct.Limit.html" title="struct bytes::buf::Limit">Limit</a></div><div class="desc docblock-short">A <code>BufMut</code> adapter which limits the amount of bytes that can be written
|
||
to an underlying buffer.</div></li><li><div class="item-name"><a class="struct" href="struct.Reader.html" title="struct bytes::buf::Reader">Reader</a></div><div class="desc docblock-short">A <code>Buf</code> adapter which implements <code>io::Read</code> for the inner value.</div></li><li><div class="item-name"><a class="struct" href="struct.Take.html" title="struct bytes::buf::Take">Take</a></div><div class="desc docblock-short">A <code>Buf</code> adapter which limits the bytes read from an underlying buffer.</div></li><li><div class="item-name"><a class="struct" href="struct.UninitSlice.html" title="struct bytes::buf::UninitSlice">UninitSlice</a></div><div class="desc docblock-short">Uninitialized byte slice.</div></li><li><div class="item-name"><a class="struct" href="struct.Writer.html" title="struct bytes::buf::Writer">Writer</a></div><div class="desc docblock-short">A <code>BufMut</code> adapter which implements <code>io::Write</code> for the inner value.</div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Buf.html" title="trait bytes::buf::Buf">Buf</a></div><div class="desc docblock-short">Read bytes from a buffer.</div></li><li><div class="item-name"><a class="trait" href="trait.BufMut.html" title="trait bytes::buf::BufMut">BufMut</a></div><div class="desc docblock-short">A trait for values that provide sequential write access to bytes.</div></li></ul></section></div></main></body></html> |