Skip to content

Commit

Permalink
Deploy Bytes API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ci committed Oct 29, 2024
0 parents commit e27bf6b
Show file tree
Hide file tree
Showing 121 changed files with 24,265 additions and 0 deletions.
Empty file added .lock
Empty file.
1 change: 1 addition & 0 deletions bytes/all.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!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="List of all items in this crate"><title>List of all items in this crate</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-405f8b29f52305f8.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.83.0-nightly (9b72238eb 2024-09-14)" data-channel="nightly" data-search-js="search-0cfde64e8ad3a7fe.js" data-settings-js="settings-7e3bb6c46e92e77c.js" ><script src="../static.files/storage-29b1d5a9048d38fe.js"></script><script defer src="../static.files/main-14659ec02b58af51.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-40f72c9259523cb3.css"></noscript><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 sys"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bytes/index.html">bytes</a><span class="version">1.8.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h3><a href="#structs">Crate 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"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="struct.Bytes.html">Bytes</a></li><li><a href="struct.BytesMut.html">BytesMut</a></li><li><a href="buf/struct.Chain.html">buf::Chain</a></li><li><a href="buf/struct.IntoIter.html">buf::IntoIter</a></li><li><a href="buf/struct.Limit.html">buf::Limit</a></li><li><a href="buf/struct.Reader.html">buf::Reader</a></li><li><a href="buf/struct.Take.html">buf::Take</a></li><li><a href="buf/struct.UninitSlice.html">buf::UninitSlice</a></li><li><a href="buf/struct.Writer.html">buf::Writer</a></li></ul><h3 id="traits">Traits</h3><ul class="all-items"><li><a href="buf/trait.Buf.html">buf::Buf</a></li><li><a href="buf/trait.BufMut.html">buf::BufMut</a></li></ul></section></div></main></body></html>
11 changes: 11 additions & 0 deletions bytes/buf/buf_impl/trait.Buf.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bytes/buf/trait.Buf.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bytes/buf/trait.Buf.html">../../../bytes/buf/trait.Buf.html</a>...</p>
<script>location.replace("../../../bytes/buf/trait.Buf.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bytes/buf/buf_mut/trait.BufMut.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bytes/buf/trait.BufMut.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bytes/buf/trait.BufMut.html">../../../bytes/buf/trait.BufMut.html</a>...</p>
<script>location.replace("../../../bytes/buf/trait.BufMut.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bytes/buf/chain/struct.Chain.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bytes/buf/struct.Chain.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bytes/buf/struct.Chain.html">../../../bytes/buf/struct.Chain.html</a>...</p>
<script>location.replace("../../../bytes/buf/struct.Chain.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bytes/buf/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!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-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-405f8b29f52305f8.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.83.0-nightly (9b72238eb 2024-09-14)" data-channel="nightly" data-search-js="search-0cfde64e8ad3a7fe.js" data-settings-js="settings-7e3bb6c46e92e77c.js" ><script src="../../static.files/storage-29b1d5a9048d38fe.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-14659ec02b58af51.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-40f72c9259523cb3.css"></noscript><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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bytes/index.html">bytes</a><span class="version">1.8.0</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"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><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">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/bytes/buf/mod.rs.html#1-39">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</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 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><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">Into<wbr>Iter</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">Uninit<wbr>Slice</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">Traits<a href="#traits" class="anchor">§</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>
11 changes: 11 additions & 0 deletions bytes/buf/iter/struct.IntoIter.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bytes/buf/struct.IntoIter.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bytes/buf/struct.IntoIter.html">../../../bytes/buf/struct.IntoIter.html</a>...</p>
<script>location.replace("../../../bytes/buf/struct.IntoIter.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bytes/buf/limit/struct.Limit.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bytes/buf/struct.Limit.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bytes/buf/struct.Limit.html">../../../bytes/buf/struct.Limit.html</a>...</p>
<script>location.replace("../../../bytes/buf/struct.Limit.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bytes/buf/reader/struct.Reader.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bytes/buf/struct.Reader.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bytes/buf/struct.Reader.html">../../../bytes/buf/struct.Reader.html</a>...</p>
<script>location.replace("../../../bytes/buf/struct.Reader.html" + location.search + location.hash);</script>
</body>
</html>
1 change: 1 addition & 0 deletions bytes/buf/sidebar-items.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit e27bf6b

Please sign in to comment.