10 lines
8.7 KiB
HTML
10 lines
8.7 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="Helpers for IO related tasks."><title>tokio_util::io - 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="tokio_util" 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 io</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../tokio_util/index.html">tokio_<wbr>util</a><span class="version">0.7.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module io</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate tokio_<wbr>util</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">tokio_util</a></div><h1>Module <span>io</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/tokio_util/io/mod.rs.html#1-35">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Helpers for IO related tasks.</p>
|
||
<p>The stream types are often used in combination with hyper or reqwest, as they
|
||
allow converting between a hyper <a href="https://docs.rs/hyper/0.13/hyper/struct.Body.html"><code>Body</code></a> and <a href="../../tokio/io/async_read/trait.AsyncRead.html" title="trait tokio::io::async_read::AsyncRead"><code>AsyncRead</code></a>.</p>
|
||
<p>The <a href="struct.SyncIoBridge.html" title="struct tokio_util::io::SyncIoBridge"><code>SyncIoBridge</code></a> type converts from the world of async I/O
|
||
to synchronous I/O; this may often come up when using synchronous APIs
|
||
inside <a href="../../tokio/task/blocking/fn.spawn_blocking.html" title="fn tokio::task::blocking::spawn_blocking"><code>tokio::task::spawn_blocking</code></a>.</p>
|
||
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="simplex/index.html" title="mod tokio_util::io::simplex">simplex</a></dt><dd>Unidirectional byte-oriented channel.</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.CopyToBytes.html" title="struct tokio_util::io::CopyToBytes">Copy<wbr>ToBytes</a></dt><dd>A helper that wraps a <a href="../../futures_sink/trait.Sink.html" title="trait futures_sink::Sink"><code>Sink</code></a><code><</code><a href="../../bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes"><code>Bytes</code></a><code>></code> and converts it into a
|
||
<a href="../../futures_sink/trait.Sink.html" title="trait futures_sink::Sink"><code>Sink</code></a><code><&'a [u8]></code> by copying each byte slice into an owned <a href="../../bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes"><code>Bytes</code></a>.</dd><dt><a class="struct" href="struct.InspectReader.html" title="struct tokio_util::io::InspectReader">Inspect<wbr>Reader</a></dt><dd>An adapter that lets you inspect the data that’s being read.</dd><dt><a class="struct" href="struct.InspectWriter.html" title="struct tokio_util::io::InspectWriter">Inspect<wbr>Writer</a></dt><dd>An adapter that lets you inspect the data that’s being written.</dd><dt><a class="struct" href="struct.ReaderStream.html" title="struct tokio_util::io::ReaderStream">Reader<wbr>Stream</a></dt><dd>Convert an <a href="../../tokio/io/async_read/trait.AsyncRead.html" title="trait tokio::io::async_read::AsyncRead"><code>AsyncRead</code></a> into a <a href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream"><code>Stream</code></a> of byte chunks.</dd><dt><a class="struct" href="struct.SinkWriter.html" title="struct tokio_util::io::SinkWriter">Sink<wbr>Writer</a></dt><dd>Convert a <a href="../../futures_sink/trait.Sink.html" title="trait futures_sink::Sink"><code>Sink</code></a> of byte chunks into an <a href="../../tokio/io/async_write/trait.AsyncWrite.html" title="trait tokio::io::async_write::AsyncWrite"><code>AsyncWrite</code></a>.</dd><dt><a class="struct" href="struct.StreamReader.html" title="struct tokio_util::io::StreamReader">Stream<wbr>Reader</a></dt><dd>Convert a <a href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream"><code>Stream</code></a> of byte chunks into an <a href="../../tokio/io/async_read/trait.AsyncRead.html" title="trait tokio::io::async_read::AsyncRead"><code>AsyncRead</code></a>.</dd><dt><a class="struct" href="struct.SyncIoBridge.html" title="struct tokio_util::io::SyncIoBridge">Sync<wbr>IoBridge</a></dt><dd>Use a <a href="../../tokio/io/async_read/trait.AsyncRead.html" title="trait tokio::io::async_read::AsyncRead"><code>tokio::io::AsyncRead</code></a> synchronously as a <a href="https://doc.rust-lang.org/1.93.1/std/io/trait.Read.html" title="trait std::io::Read"><code>std::io::Read</code></a> or
|
||
a <a href="../../tokio/io/async_write/trait.AsyncWrite.html" title="trait tokio::io::async_write::AsyncWrite"><code>tokio::io::AsyncWrite</code></a> synchronously as a <a href="https://doc.rust-lang.org/1.93.1/std/io/trait.Write.html" title="trait std::io::Write"><code>std::io::Write</code></a>.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.poll_read_buf.html" title="fn tokio_util::io::poll_read_buf">poll_<wbr>read_<wbr>buf</a></dt><dd>Try to read data from an <code>AsyncRead</code> into an implementer of the <a href="../../bytes/buf/buf_impl/trait.Buf.html" title="trait bytes::buf::buf_impl::Buf"><code>BufMut</code></a> trait.</dd><dt><a class="fn" href="fn.poll_write_buf.html" title="fn tokio_util::io::poll_write_buf">poll_<wbr>write_<wbr>buf</a></dt><dd>Try to write data from an implementer of the <a href="../../bytes/buf/buf_impl/trait.Buf.html" title="trait bytes::buf::buf_impl::Buf"><code>Buf</code></a> trait to an
|
||
<a href="../../tokio/io/async_write/trait.AsyncWrite.html" title="trait tokio::io::async_write::AsyncWrite"><code>AsyncWrite</code></a>, advancing the buffer’s internal cursor.</dd><dt><a class="fn" href="fn.read_buf.html" title="fn tokio_util::io::read_buf">read_<wbr>buf</a></dt><dd>Read data from an <code>AsyncRead</code> into an implementer of the <a href="../../bytes/buf/buf_mut/trait.BufMut.html" title="trait bytes::buf::buf_mut::BufMut"><code>BufMut</code></a> trait.</dd><dt><a class="fn" href="fn.read_exact_arc.html" title="fn tokio_util::io::read_exact_arc">read_<wbr>exact_<wbr>arc</a></dt><dd>Read data from an <code>AsyncRead</code> into an <code>Arc</code>.</dd></dl></section></div></main></body></html> |