mirror of
https://github.com/actix/actix-website
synced 2025-02-13 16:42:21 +01:00
29 lines
11 KiB
HTML
29 lines
11 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 `WrapStream` trait in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, WrapStream"><title>actix_web::actix::fut::WrapStream - 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></head><body class="rustdoc trait"><!--[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><p class='location'>Trait WrapStream</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Stream">Stream</a><a href="#associatedtype.Item">Item</a><a href="#associatedtype.Error">Error</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.into_actor">into_actor</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>actix</a>::<wbr><a href='index.html'>fut</a></p><script>window.sidebarCurrent = {name: 'WrapStream', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></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 js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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='in-band'>Trait <a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>actix</a>::<wbr><a href='index.html'>fut</a>::<wbr><a class="trait" href=''>WrapStream</a></span><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></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait WrapStream<A> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../../actix_web/actix/actix/trait.Actor.html" title="trait actix_web::actix::actix::Actor">Actor</a>,<br> <Self::<a class="type" href="../../../actix_web/actix/actix/dev/trait.WrapStream.html#associatedtype.Stream" title="type actix_web::actix::actix::dev::WrapStream::Stream">Stream</a> as <a class="trait" href="../../../actix_web/actix/actix/dev/trait.ActorStream.html" title="trait actix_web::actix::actix::dev::ActorStream">ActorStream</a>>::<a class="type" href="../../../actix_web/actix/actix/dev/trait.ActorStream.html#associatedtype.Item" title="type actix_web::actix::actix::dev::ActorStream::Item">Item</a> == Self::<a class="type" href="../../../actix_web/actix/actix/dev/trait.WrapStream.html#associatedtype.Item" title="type actix_web::actix::actix::dev::WrapStream::Item">Item</a>,<br> <Self::<a class="type" href="../../../actix_web/actix/actix/dev/trait.WrapStream.html#associatedtype.Stream" title="type actix_web::actix::actix::dev::WrapStream::Stream">Stream</a> as <a class="trait" href="../../../actix_web/actix/actix/dev/trait.ActorStream.html" title="trait actix_web::actix::actix::dev::ActorStream">ActorStream</a>>::<a class="type" href="../../../actix_web/actix/actix/dev/trait.ActorStream.html#associatedtype.Error" title="type actix_web::actix::actix::dev::ActorStream::Error">Error</a> == Self::<a class="type" href="../../../actix_web/actix/actix/dev/trait.WrapStream.html#associatedtype.Error" title="type actix_web::actix::actix::dev::WrapStream::Error">Error</a>,<br> <Self::<a class="type" href="../../../actix_web/actix/actix/dev/trait.WrapStream.html#associatedtype.Stream" title="type actix_web::actix::actix::dev::WrapStream::Stream">Stream</a> as <a class="trait" href="../../../actix_web/actix/actix/dev/trait.ActorStream.html" title="trait actix_web::actix::actix::dev::ActorStream">ActorStream</a>>::<a class="type" href="../../../actix_web/actix/actix/dev/trait.ActorStream.html#associatedtype.Actor" title="type actix_web::actix::actix::dev::ActorStream::Actor">Actor</a> == A, </span>{
|
||
type <a href='#associatedtype.Stream' class="type">Stream</a>: <a class="trait" href="../../../actix_web/actix/actix/dev/trait.ActorStream.html" title="trait actix_web::actix::actix::dev::ActorStream">ActorStream</a>;
|
||
type <a href='#associatedtype.Item' class="type">Item</a>;
|
||
type <a href='#associatedtype.Error' class="type">Error</a>;
|
||
fn <a href='#tymethod.into_actor' class='fnname'>into_actor</a>(self, a: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A) -> Self::<a class="type" href="../../../actix_web/actix/actix/dev/trait.WrapStream.html#associatedtype.Stream" title="type actix_web::actix::actix::dev::WrapStream::Stream">Stream</a>;
|
||
}</pre></div><div class='docblock'><p>Helper trait that allows conversion of normal stream into <code>ActorStream</code></p>
|
||
</div>
|
||
<h2 id='associated-types' class='small-section-header'>
|
||
Associated Types<a href='#associated-types' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='associatedtype.Stream' class='method'><span id='Stream.t' class='invisible'><code>type <a href='#associatedtype.Stream' class="type">Stream</a>: <a class="trait" href="../../../actix_web/actix/actix/dev/trait.ActorStream.html" title="trait actix_web::actix::actix::dev::ActorStream">ActorStream</a></code></span></h3><div class='docblock'><p>The stream that this type can be converted into.</p>
|
||
</div><h3 id='associatedtype.Item' class='method'><span id='Item.t' class='invisible'><code>type <a href='#associatedtype.Item' class="type">Item</a></code></span></h3><div class='docblock'><p>The item that the future may resolve with.</p>
|
||
</div><h3 id='associatedtype.Error' class='method'><span id='Error.t' class='invisible'><code>type <a href='#associatedtype.Error' class="type">Error</a></code></span></h3><div class='docblock'><p>The error that the future may resolve with.</p>
|
||
</div></div>
|
||
<h2 id='required-methods' class='small-section-header'>
|
||
Required Methods<a href='#required-methods' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.into_actor' class='method'><span id='into_actor.v' class='invisible'><code>fn <a href='#tymethod.into_actor' class='fnname'>into_actor</a>(self, a: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A) -> Self::<a class="type" href="../../../actix_web/actix/actix/dev/trait.WrapStream.html#associatedtype.Stream" title="type actix_web::actix::actix::dev::WrapStream::Stream">Stream</a></code></span></h3><div class='docblock'><p>Convert normal stream to a ActorStream</p>
|
||
</div></div>
|
||
<h2 id='implementors' class='small-section-header'>
|
||
Implementors<a href='#implementors' class='anchor'></a>
|
||
</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<S, A> WrapStream<A> for S <span class="where fmt-newline">where<br> A: <a class="trait" href="../../../actix_web/actix/actix/trait.Actor.html" title="trait actix_web::actix::actix::Actor">Actor</a>,<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>, </span><span class="where fmt-newline"> type <a href='#associatedtype.Stream' class="type">Stream</a> = <a class="struct" href="../../../actix_web/actix/actix/dev/fut/struct.StreamWrap.html" title="struct actix_web::actix::actix::dev::fut::StreamWrap">StreamWrap</a><S, A>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Item' class="type">Item</a> = <S as <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Error' class="type">Error</a> = <S as <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>;</span></code><td></td></tr></tbody></table></li>
|
||
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../../../implementors/actix/fut/trait.WrapStream.js">
|
||
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "actix_web";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |