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 Mar 22, 2024
0 parents commit ddfe81b
Show file tree
Hide file tree
Showing 132 changed files with 30,536 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"><meta name="keywords" content="rust, rustlang, rust-lang"><title>List of all items in this crate</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-1f7d512b176f0f72.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/SourceSerif4-Bold-124a1ca42af929b6.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-eabf764633b9d7be.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../static.files/light-777f3e9583f8c92d.css"><link rel="stylesheet" disabled href="../static.files/dark-e2f4109f2e82e3af.css"><link rel="stylesheet" disabled href="../static.files/ayu-c360e709a65bed99.css"><script id="default-settings" ></script><script src="../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="../static.files/main-c2d2a5dbaed13e6b.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-13285aec31fa243e.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">&#9776;</button><a class="sidebar-logo" href="../bytes/index.html"><div class="logo-container"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../bytes/index.html"><div class="logo-container"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2 class="location">Crate bytes</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></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><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="../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><h1 class="fqn">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="trait.Buf.html">Buf</a></li><li><a href="trait.BufMut.html">BufMut</a></li><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><div id="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bytes" data-themes="" data-resource-suffix="" data-rustdoc-version="1.67.0-nightly (42325c525 2022-11-11)" data-search-js="search-39ee4160c7dc16c9.js" data-settings-js="settings-3a0b9947ba1bd99a.js" data-settings-css="settings-a66f7524084a489a.css" ></div></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."><meta name="keywords" content="rust, rustlang, rust-lang, buf"><title>bytes::buf - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.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/SourceSerif4-Bold-124a1ca42af929b6.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-eabf764633b9d7be.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-777f3e9583f8c92d.css"><link rel="stylesheet" disabled href="../../static.files/dark-e2f4109f2e82e3af.css"><link rel="stylesheet" disabled href="../../static.files/ayu-c360e709a65bed99.css"><script id="default-settings" ></script><script src="../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="../../static.files/main-c2d2a5dbaed13e6b.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.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">&#9776;</button><a class="sidebar-logo" href="../../bytes/index.html"><div class="logo-container"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../bytes/index.html"><div class="logo-container"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><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></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><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="../../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">bytes</a>::<wbr><a class="mod" href="#">buf</a><button id="copy-path" onclick="copy_path(this)" 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="srclink" 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="rustdoc-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" title="Buf"><code>Buf</code></a> and <a href="trait.BufMut.html" title="BufMut"><code>BufMut</code></a> for more details.</p>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Chain.html" title="bytes::buf::Chain struct">Chain</a></div><div class="item-right docblock-short">A <code>Chain</code> sequences two buffers.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IntoIter.html" title="bytes::buf::IntoIter struct">IntoIter</a></div><div class="item-right docblock-short">Iterator over the bytes contained by the buffer.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Limit.html" title="bytes::buf::Limit struct">Limit</a></div><div class="item-right docblock-short">A <code>BufMut</code> adapter which limits the amount of bytes that can be written
to an underlying buffer.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Reader.html" title="bytes::buf::Reader struct">Reader</a></div><div class="item-right docblock-short">A <code>Buf</code> adapter which implements <code>io::Read</code> for the inner value.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Take.html" title="bytes::buf::Take struct">Take</a></div><div class="item-right docblock-short">A <code>Buf</code> adapter which limits the bytes read from an underlying buffer.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UninitSlice.html" title="bytes::buf::UninitSlice struct">UninitSlice</a></div><div class="item-right docblock-short">Uninitialized byte slice.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Writer.html" title="bytes::buf::Writer struct">Writer</a></div><div class="item-right docblock-short">A <code>BufMut</code> adapter which implements <code>io::Write</code> for the inner value.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Buf.html" title="bytes::buf::Buf trait">Buf</a></div><div class="item-right docblock-short">Read bytes from a buffer.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.BufMut.html" title="bytes::buf::BufMut trait">BufMut</a></div><div class="item-right docblock-short">A trait for values that provide sequential write access to bytes.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bytes" data-themes="" data-resource-suffix="" data-rustdoc-version="1.67.0-nightly (42325c525 2022-11-11)" data-search-js="search-39ee4160c7dc16c9.js" data-settings-js="settings-3a0b9947ba1bd99a.js" data-settings-css="settings-a66f7524084a489a.css" ></div></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 ddfe81b

Please sign in to comment.