mirror of
https://github.com/fafhrd91/actix-net
synced 2025-01-18 23:21:50 +01:00
6 lines
6.5 KiB
HTML
6 lines
6.5 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="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-b778ab399e080a4b.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.83.0-nightly (7608018cb 2024-09-29)" data-channel="nightly" data-search-js="search-e056c65ede92db13.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-54bc299d2a5e4e43.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-0111fcff984fae8f.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_<wbr>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 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><li><a href="#functions" title="Functions">Functions</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"><div class="main-heading"><h1>Crate <span>actix_codec</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/actix_codec/lib.rs.html#1-28">source</a> </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">Bytes<wbr>Codec</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">Framed<wbr>Parts</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">Lines<wbr>Codec</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">Async<wbr>Read</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">Async<wbr>Write</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_<wbr>read_<wbr>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> |