20 lines
5.7 KiB
HTML
20 lines
5.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="API documentation for the Rust `actix_codec` crate."><meta name="keywords" content="rust, rustlang, rust-lang, actix_codec"><title>actix_codec - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../actix_codec/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate actix_codec</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all actix_codec's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'actix_codec', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/actix_codec/lib.rs.html#1-24' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>actix_codec</a></span></h1><div class='docblock'><p>Utilities for encoding and decoding frames.</p>
|
||
<p>Contains adapters to go from streams of bytes, <a href="#"><code>AsyncRead</code></a> and
|
||
<a href="#"><code>AsyncWrite</code></a>, to framed streams implementing <a href="#"><code>Sink</code></a> and <a href="#"><code>Stream</code></a>.
|
||
Framed streams are also known as <a href="#">transports</a>.</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.BytesCodec.html" title='actix_codec::BytesCodec struct'>BytesCodec</a></td><td class='docblock-short'><p>Bytes codec.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Framed.html" title='actix_codec::Framed struct'>Framed</a></td><td class='docblock-short'><p>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.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FramedParts.html" title='actix_codec::FramedParts struct'>FramedParts</a></td><td class='docblock-short'><p><code>FramedParts</code> contains an export of the data of a Framed transport.
|
||
It can be used to construct a new <code>Framed</code> with a different codec.
|
||
It contains all current buffers and the inner transport.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FramedRead.html" title='actix_codec::FramedRead struct'>FramedRead</a></td><td class='docblock-short'><p>A <code>Stream</code> of messages decoded from an <code>AsyncRead</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FramedWrite.html" title='actix_codec::FramedWrite struct'>FramedWrite</a></td><td class='docblock-short'><p>A <code>Sink</code> of frames encoded to an <code>AsyncWrite</code>.</p>
|
||
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table><tr class='module-item'><td><a class="trait" href="trait.AsyncRead.html" title='actix_codec::AsyncRead trait'>AsyncRead</a></td><td class='docblock-short'><p>Read bytes asynchronously.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.AsyncWrite.html" title='actix_codec::AsyncWrite trait'>AsyncWrite</a></td><td class='docblock-short'><p>Writes bytes asynchronously.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Decoder.html" title='actix_codec::Decoder trait'>Decoder</a></td><td class='docblock-short'><p>Decoding of frames via buffers.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Encoder.html" title='actix_codec::Encoder trait'>Encoder</a></td><td class='docblock-short'><p>Trait of helper objects to write out messages as bytes, for use with
|
||
<code>FramedWrite</code>.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "actix_codec";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |