Deploying to gh-pages from @ 779fa28 🚀

actix · Jul 29, 2024 · f543ed2 · f543ed2
commit f543ed2
Show file tree

Hide file tree

Showing 501 changed files with 42,682 additions and 0 deletions.
diff --git a/.lock b/.lock
diff --git a/.nojekyll b/.nojekyll
diff --git a/actix_codec/all.html b/actix_codec/all.html
@@ -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-99073656bbb10eb3.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="actix_codec" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0-nightly (2cbbe8b8b 2024-07-28)" data-channel="nightly" data-search-js="search-ef54e092fea9c776.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../static.files/main-2a506944c89e7bb4.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></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><a class="logo-container" href="../actix_codec/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../actix_codec/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../actix_codec/index.html">actix_codec</a><span class="version">0.5.2</span></h2></div><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section></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.BytesCodec.html">BytesCodec</a></li><li><a href="struct.Framed.html">Framed</a></li><li><a href="struct.FramedParts.html">FramedParts</a></li><li><a href="struct.LinesCodec.html">LinesCodec</a></li><li><a href="struct.ReadBuf.html">ReadBuf</a></li></ul><h3 id="traits">Traits</h3><ul class="all-items"><li><a href="trait.AsyncRead.html">AsyncRead</a></li><li><a href="trait.AsyncWrite.html">AsyncWrite</a></li><li><a href="trait.Decoder.html">Decoder</a></li><li><a href="trait.Encoder.html">Encoder</a></li></ul><h3 id="functions">Functions</h3><ul class="all-items"><li><a href="fn.poll_read_buf.html">poll_read_buf</a></li></ul></section></div></main></body></html>
diff --git a/actix_codec/bcodec/struct.BytesCodec.html b/actix_codec/bcodec/struct.BytesCodec.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="refresh" content="0;URL=../../actix_codec/struct.BytesCodec.html">
+    <title>Redirection</title>
+</head>
+<body>
+    <p>Redirecting to <a href="../../actix_codec/struct.BytesCodec.html">../../actix_codec/struct.BytesCodec.html</a>...</p>
+    <script>location.replace("../../actix_codec/struct.BytesCodec.html" + location.search + location.hash);</script>
+</body>
+</html>
diff --git a/actix_codec/fn.poll_read_buf.html b/actix_codec/fn.poll_read_buf.html
@@ -0,0 +1,35 @@
+<!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="Try to read data from an `AsyncRead` into an implementer of the `BufMut` trait."><title>poll_read_buf in actix_codec - 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-99073656bbb10eb3.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="actix_codec" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0-nightly (2cbbe8b8b 2024-07-28)" data-channel="nightly" data-search-js="search-ef54e092fea9c776.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-2a506944c89e7bb4.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc fn"><!--[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><a class="logo-container" href="../actix_codec/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../actix_codec/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../actix_codec/index.html">actix_codec</a><span class="version">0.5.2</span></h2></div><div class="sidebar-elems"></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>Function <a href="index.html">actix_codec</a>::<wbr><a class="fn" href="#">poll_read_buf</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn poll_read_buf&lt;T, B&gt;(
+    io: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut T</a>&gt;,
+    cx: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a>&lt;'_&gt;,
+    buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut B</a>,
+) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt;&gt;<div class="where">where
+    T: <a class="trait" href="trait.AsyncRead.html" title="trait actix_codec::AsyncRead">AsyncRead</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
+    B: BufMut,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Try to read data from an <code>AsyncRead</code> into an implementer of the <a href="bytes::Buf"><code>BufMut</code></a> trait.</p>
+<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
+<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>bytes::{Bytes, BytesMut};
+<span class="kw">use </span>tokio_stream <span class="kw">as </span>stream;
+<span class="kw">use </span>tokio::io::Result;
+<span class="kw">use </span>tokio_util::io::{StreamReader, poll_read_buf};
+<span class="kw">use </span>futures::future::poll_fn;
+<span class="kw">use </span>std::pin::Pin;
+
+<span class="comment">// Create a reader from an iterator. This particular reader will always be
+// ready.
+</span><span class="kw">let </span><span class="kw-2">mut </span>read = StreamReader::new(stream::iter(<span class="macro">vec!</span>[Result::Ok(Bytes::from_static(<span class="kw-2">&amp;</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]))]));
+
+<span class="kw">let </span><span class="kw-2">mut </span>buf = BytesMut::new();
+<span class="kw">let </span><span class="kw-2">mut </span>reads = <span class="number">0</span>;
+
+<span class="kw">loop </span>{
+    reads += <span class="number">1</span>;
+    <span class="kw">let </span>n = poll_fn(|cx| poll_read_buf(Pin::new(<span class="kw-2">&amp;mut </span>read), cx, <span class="kw-2">&amp;mut </span>buf)).<span class="kw">await</span><span class="question-mark">?</span>;
+
+    <span class="kw">if </span>n == <span class="number">0 </span>{
+        <span class="kw">break</span>;
+    }
+}
+
+<span class="comment">// one or more reads might be necessary.
+</span><span class="macro">assert!</span>(reads &gt;= <span class="number">1</span>);
+<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>buf[..], <span class="kw-2">&amp;</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]);</code></pre></div>
+</div></details></section></div></main></body></html>
diff --git a/actix_codec/framed/struct.Framed.html b/actix_codec/framed/struct.Framed.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="refresh" content="0;URL=../../actix_codec/struct.Framed.html">
+    <title>Redirection</title>
+</head>
+<body>
+    <p>Redirecting to <a href="../../actix_codec/struct.Framed.html">../../actix_codec/struct.Framed.html</a>...</p>
+    <script>location.replace("../../actix_codec/struct.Framed.html" + location.search + location.hash);</script>
+</body>
+</html>
diff --git a/actix_codec/framed/struct.FramedParts.html b/actix_codec/framed/struct.FramedParts.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="refresh" content="0;URL=../../actix_codec/struct.FramedParts.html">
+    <title>Redirection</title>
+</head>
+<body>
+    <p>Redirecting to <a href="../../actix_codec/struct.FramedParts.html">../../actix_codec/struct.FramedParts.html</a>...</p>
+    <script>location.replace("../../actix_codec/struct.FramedParts.html" + location.search + location.hash);</script>
+</body>
+</html>
diff --git a/actix_codec/index.html b/actix_codec/index.html
@@ -0,0 +1,6 @@
+<!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="Codec utilities for working with framed protocols."><title>actix_codec - 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-99073656bbb10eb3.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="actix_codec" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0-nightly (2cbbe8b8b 2024-07-28)" data-channel="nightly" data-search-js="search-ef54e092fea9c776.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-2a506944c89e7bb4.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc mod crate"><!--[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><a class="logo-container" href="../actix_codec/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../actix_codec/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../actix_codec/index.html">actix_codec</a><span class="version">0.5.2</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section></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>Crate <a class="mod" href="#">actix_codec</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/actix_codec/lib.rs.html#1-28">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>Codec utilities for working with framed protocols.</p>
+<p>Contains adapters to go from streams of bytes, <a href="trait.AsyncRead.html" title="trait actix_codec::AsyncRead"><code>AsyncRead</code></a> and <a href="trait.AsyncWrite.html" title="trait actix_codec::AsyncWrite"><code>AsyncWrite</code></a>, to framed
+streams implementing <a href="futures_sink::Sink"><code>Sink</code></a> and <a href="futures_core::Stream"><code>Stream</code></a>. Framed streams are also known as <code>transports</code>.</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.BytesCodec.html" title="struct actix_codec::BytesCodec">BytesCodec</a></div><div class="desc docblock-short">Bytes codec. Reads/writes chunks of bytes from a stream.</div></li><li><div class="item-name"><a class="struct" href="struct.Framed.html" title="struct actix_codec::Framed">Framed</a></div><div class="desc docblock-short">A unified <code>Stream</code> and <code>Sink</code> interface to an underlying I/O object, using the <code>Encoder</code> and
+<code>Decoder</code> traits to encode and decode frames.</div></li><li><div class="item-name"><a class="struct" href="struct.FramedParts.html" title="struct actix_codec::FramedParts">FramedParts</a></div><div class="desc docblock-short"><code>FramedParts</code> contains an export of the data of a Framed transport.</div></li><li><div class="item-name"><a class="struct" href="struct.LinesCodec.html" title="struct actix_codec::LinesCodec">LinesCodec</a></div><div class="desc docblock-short">Lines codec. Reads/writes line delimited strings.</div></li><li><div class="item-name"><a class="struct" href="struct.ReadBuf.html" title="struct actix_codec::ReadBuf">ReadBuf</a></div><div class="desc docblock-short">A wrapper around a byte buffer that is incrementally filled and initialized.</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.AsyncRead.html" title="trait actix_codec::AsyncRead">AsyncRead</a></div><div class="desc docblock-short">Reads bytes from a source.</div></li><li><div class="item-name"><a class="trait" href="trait.AsyncWrite.html" title="trait actix_codec::AsyncWrite">AsyncWrite</a></div><div class="desc docblock-short">Writes bytes asynchronously.</div></li><li><div class="item-name"><a class="trait" href="trait.Decoder.html" title="trait actix_codec::Decoder">Decoder</a></div><div class="desc docblock-short">Decoding of frames via buffers.</div></li><li><div class="item-name"><a class="trait" href="trait.Encoder.html" title="trait actix_codec::Encoder">Encoder</a></div><div class="desc docblock-short">Trait of helper objects to write out messages as bytes, for use with
+<a href="crate::codec::FramedWrite"><code>FramedWrite</code></a>.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.poll_read_buf.html" title="fn actix_codec::poll_read_buf">poll_read_buf</a></div><div class="desc docblock-short">Try to read data from an <code>AsyncRead</code> into an implementer of the <a href="bytes::Buf"><code>BufMut</code></a> trait.</div></li></ul></section></div></main></body></html>
diff --git a/actix_codec/lines/struct.LinesCodec.html b/actix_codec/lines/struct.LinesCodec.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="refresh" content="0;URL=../../actix_codec/struct.LinesCodec.html">
+    <title>Redirection</title>
+</head>
+<body>
+    <p>Redirecting to <a href="../../actix_codec/struct.LinesCodec.html">../../actix_codec/struct.LinesCodec.html</a>...</p>
+    <script>location.replace("../../actix_codec/struct.LinesCodec.html" + location.search + location.hash);</script>
+</body>
+</html>
diff --git a/actix_codec/sidebar-items.js b/actix_codec/sidebar-items.js