mirror of
https://github.com/actix/actix-website
synced 2025-06-30 00:34:58 +02:00
Add api docs
This commit is contained in:
Nikolay Kim
10
static/api/actix-web/0.7.0/stable/ws/Client.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/Client.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.Client.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.Client.html">struct.Client.html</a>...</p>
|
||||
<script>location.replace("struct.Client.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/ClientError.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/ClientError.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=enum.ClientError.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="enum.ClientError.html">enum.ClientError.html</a>...</p>
|
||||
<script>location.replace("enum.ClientError.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/ClientHandshake.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/ClientHandshake.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.ClientHandshake.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.ClientHandshake.html">struct.ClientHandshake.html</a>...</p>
|
||||
<script>location.replace("struct.ClientHandshake.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/ClientReader.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/ClientReader.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.ClientReader.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.ClientReader.html">struct.ClientReader.html</a>...</p>
|
||||
<script>location.replace("struct.ClientReader.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/ClientWriter.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/ClientWriter.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.ClientWriter.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.ClientWriter.html">struct.ClientWriter.html</a>...</p>
|
||||
<script>location.replace("struct.ClientWriter.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/CloseCode.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/CloseCode.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=enum.CloseCode.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="enum.CloseCode.html">enum.CloseCode.html</a>...</p>
|
||||
<script>location.replace("enum.CloseCode.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/CloseReason.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/CloseReason.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.CloseReason.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.CloseReason.html">struct.CloseReason.html</a>...</p>
|
||||
<script>location.replace("struct.CloseReason.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/Frame.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/Frame.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.Frame.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.Frame.html">struct.Frame.html</a>...</p>
|
||||
<script>location.replace("struct.Frame.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/FramedMessage.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/FramedMessage.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.FramedMessage.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.FramedMessage.html">struct.FramedMessage.html</a>...</p>
|
||||
<script>location.replace("struct.FramedMessage.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/HandshakeError.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/HandshakeError.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=enum.HandshakeError.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="enum.HandshakeError.html">enum.HandshakeError.html</a>...</p>
|
||||
<script>location.replace("enum.HandshakeError.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/Message.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/Message.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=enum.Message.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="enum.Message.html">enum.Message.html</a>...</p>
|
||||
<script>location.replace("enum.Message.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/OpCode.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/OpCode.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=enum.OpCode.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="enum.OpCode.html">enum.OpCode.html</a>...</p>
|
||||
<script>location.replace("enum.OpCode.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/ProtocolError.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/ProtocolError.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=enum.ProtocolError.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="enum.ProtocolError.html">enum.ProtocolError.html</a>...</p>
|
||||
<script>location.replace("enum.ProtocolError.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/WebsocketContext.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/WebsocketContext.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.WebsocketContext.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.WebsocketContext.html">struct.WebsocketContext.html</a>...</p>
|
||||
<script>location.replace("struct.WebsocketContext.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/WsStream.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/WsStream.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.WsStream.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.WsStream.html">struct.WsStream.html</a>...</p>
|
||||
<script>location.replace("struct.WsStream.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/WsWriter.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/WsWriter.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=trait.WsWriter.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="trait.WsWriter.html">trait.WsWriter.html</a>...</p>
|
||||
<script>location.replace("trait.WsWriter.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/client/Client.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/client/Client.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.Client.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.Client.html">struct.Client.html</a>...</p>
|
||||
<script>location.replace("struct.Client.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=enum.ClientError.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="enum.ClientError.html">enum.ClientError.html</a>...</p>
|
||||
<script>location.replace("enum.ClientError.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.ClientHandshake.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.ClientHandshake.html">struct.ClientHandshake.html</a>...</p>
|
||||
<script>location.replace("struct.ClientHandshake.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.ClientReader.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.ClientReader.html">struct.ClientReader.html</a>...</p>
|
||||
<script>location.replace("struct.ClientReader.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.ClientWriter.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.ClientWriter.html">struct.ClientWriter.html</a>...</p>
|
||||
<script>location.replace("struct.ClientWriter.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../actix_web/ws/enum.ClientError.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../actix_web/ws/enum.ClientError.html">../../../actix_web/ws/enum.ClientError.html</a>...</p>
|
||||
<script>location.replace("../../../actix_web/ws/enum.ClientError.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../actix_web/ws/struct.Client.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../actix_web/ws/struct.Client.html">../../../actix_web/ws/struct.Client.html</a>...</p>
|
||||
<script>location.replace("../../../actix_web/ws/struct.Client.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../actix_web/ws/struct.ClientHandshake.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../actix_web/ws/struct.ClientHandshake.html">../../../actix_web/ws/struct.ClientHandshake.html</a>...</p>
|
||||
<script>location.replace("../../../actix_web/ws/struct.ClientHandshake.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../actix_web/ws/struct.ClientReader.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../actix_web/ws/struct.ClientReader.html">../../../actix_web/ws/struct.ClientReader.html</a>...</p>
|
||||
<script>location.replace("../../../actix_web/ws/struct.ClientReader.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../actix_web/ws/struct.ClientWriter.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../actix_web/ws/struct.ClientWriter.html">../../../actix_web/ws/struct.ClientWriter.html</a>...</p>
|
||||
<script>location.replace("../../../actix_web/ws/struct.ClientWriter.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.WebsocketContext.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.WebsocketContext.html">struct.WebsocketContext.html</a>...</p>
|
||||
<script>location.replace("struct.WebsocketContext.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../actix_web/ws/struct.WebsocketContext.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../actix_web/ws/struct.WebsocketContext.html">../../../actix_web/ws/struct.WebsocketContext.html</a>...</p>
|
||||
<script>location.replace("../../../actix_web/ws/struct.WebsocketContext.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
55
static/api/actix-web/0.7.0/stable/ws/enum.ClientError.html
Normal file
55
static/api/actix-web/0.7.0/stable/ws/enum.ClientError.html
Normal file
@ -0,0 +1,55 @@
|
||||
<!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 `ClientError` enum in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, ClientError"><title>actix_web::ws::ClientError - 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 enum"><!--[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'>Enum ClientError</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.InvalidUrl">InvalidUrl</a><a href="#variant.InvalidResponseStatus">InvalidResponseStatus</a><a href="#variant.InvalidUpgradeHeader">InvalidUpgradeHeader</a><a href="#variant.InvalidConnectionHeader">InvalidConnectionHeader</a><a href="#variant.MissingConnectionHeader">MissingConnectionHeader</a><a href="#variant.MissingWebSocketAcceptHeader">MissingWebSocketAcceptHeader</a><a href="#variant.InvalidChallengeResponse">InvalidChallengeResponse</a><a href="#variant.Http">Http</a><a href="#variant.Url">Url</a><a href="#variant.ResponseParseError">ResponseParseError</a><a href="#variant.SendRequest">SendRequest</a><a href="#variant.Protocol">Protocol</a><a href="#variant.Io">Io</a><a href="#variant.Disconnected">Disconnected</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Fail">Fail</a><a href="#impl-Display">Display</a><a href="#impl-Debug">Debug</a><a href="#impl-From%3CError%3E">From<Error></a><a href="#impl-From%3CUrlParseError%3E">From<UrlParseError></a><a href="#impl-From%3CSendRequestError%3E">From<SendRequestError></a><a href="#impl-From%3CProtocolError%3E">From<ProtocolError></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'ClientError', ty: 'enum', 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'>Enum <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="enum" href=''>ClientError</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><a class='srclink' href='../../src/actix_web/ws/client.rs.html#36-79' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum ClientError {
|
||||
InvalidUrl,
|
||||
InvalidResponseStatus(<a class="struct" href="../../actix_web/http/struct.StatusCode.html" title="struct actix_web::http::StatusCode">StatusCode</a>),
|
||||
InvalidUpgradeHeader,
|
||||
InvalidConnectionHeader(<a class="struct" href="../../actix_web/http/header/struct.HeaderValue.html" title="struct actix_web::http::header::HeaderValue">HeaderValue</a>),
|
||||
MissingConnectionHeader,
|
||||
MissingWebSocketAcceptHeader,
|
||||
InvalidChallengeResponse(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="../../actix_web/http/header/struct.HeaderValue.html" title="struct actix_web::http::header::HeaderValue">HeaderValue</a>),
|
||||
Http(<a class="struct" href="../../actix_web/error/struct.Error.html" title="struct actix_web::error::Error">Error</a>),
|
||||
Url(<a class="enum" href="../../actix_web/error/enum.UrlParseError.html" title="enum actix_web::error::UrlParseError">UrlParseError</a>),
|
||||
ResponseParseError(HttpResponseParserError),
|
||||
SendRequest(<a class="enum" href="../../actix_web/client/enum.SendRequestError.html" title="enum actix_web::client::SendRequestError">SendRequestError</a>),
|
||||
Protocol(<a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a>),
|
||||
Io(<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>),
|
||||
Disconnected,
|
||||
}</pre></div><div class='docblock'><p>Websocket client error</p>
|
||||
</div><h2 id='variants' class='variants small-section-header'>
|
||||
Variants<a href='#variants' class='anchor'></a></h2>
|
||||
<span id="variant.InvalidUrl" class="variant small-section-header"><a href="#variant.InvalidUrl" class="anchor field"></a><span id='InvalidUrl.v' class='invisible'><code>InvalidUrl</code></span></span><div class='docblock'><p>Invalid url</p>
|
||||
</div><span id="variant.InvalidResponseStatus" class="variant small-section-header"><a href="#variant.InvalidResponseStatus" class="anchor field"></a><span id='InvalidResponseStatus.v' class='invisible'><code>InvalidResponseStatus(<a class="struct" href="../../actix_web/http/struct.StatusCode.html" title="struct actix_web::http::StatusCode">StatusCode</a>)</code></span></span><div class='docblock'><p>Invalid response status</p>
|
||||
</div><span id="variant.InvalidUpgradeHeader" class="variant small-section-header"><a href="#variant.InvalidUpgradeHeader" class="anchor field"></a><span id='InvalidUpgradeHeader.v' class='invisible'><code>InvalidUpgradeHeader</code></span></span><div class='docblock'><p>Invalid upgrade header</p>
|
||||
</div><span id="variant.InvalidConnectionHeader" class="variant small-section-header"><a href="#variant.InvalidConnectionHeader" class="anchor field"></a><span id='InvalidConnectionHeader.v' class='invisible'><code>InvalidConnectionHeader(<a class="struct" href="../../actix_web/http/header/struct.HeaderValue.html" title="struct actix_web::http::header::HeaderValue">HeaderValue</a>)</code></span></span><div class='docblock'><p>Invalid connection header</p>
|
||||
</div><span id="variant.MissingConnectionHeader" class="variant small-section-header"><a href="#variant.MissingConnectionHeader" class="anchor field"></a><span id='MissingConnectionHeader.v' class='invisible'><code>MissingConnectionHeader</code></span></span><div class='docblock'><p>Missing CONNECTION header</p>
|
||||
</div><span id="variant.MissingWebSocketAcceptHeader" class="variant small-section-header"><a href="#variant.MissingWebSocketAcceptHeader" class="anchor field"></a><span id='MissingWebSocketAcceptHeader.v' class='invisible'><code>MissingWebSocketAcceptHeader</code></span></span><div class='docblock'><p>Missing SEC-WEBSOCKET-ACCEPT header</p>
|
||||
</div><span id="variant.InvalidChallengeResponse" class="variant small-section-header"><a href="#variant.InvalidChallengeResponse" class="anchor field"></a><span id='InvalidChallengeResponse.v' class='invisible'><code>InvalidChallengeResponse(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="../../actix_web/http/header/struct.HeaderValue.html" title="struct actix_web::http::header::HeaderValue">HeaderValue</a>)</code></span></span><div class='docblock'><p>Invalid challenge response</p>
|
||||
</div><span id="variant.Http" class="variant small-section-header"><a href="#variant.Http" class="anchor field"></a><span id='Http.v' class='invisible'><code>Http(<a class="struct" href="../../actix_web/error/struct.Error.html" title="struct actix_web::error::Error">Error</a>)</code></span></span><div class='docblock'><p>Http parsing error</p>
|
||||
</div><span id="variant.Url" class="variant small-section-header"><a href="#variant.Url" class="anchor field"></a><span id='Url.v' class='invisible'><code>Url(<a class="enum" href="../../actix_web/error/enum.UrlParseError.html" title="enum actix_web::error::UrlParseError">UrlParseError</a>)</code></span></span><div class='docblock'><p>Url parsing error</p>
|
||||
</div><span id="variant.ResponseParseError" class="variant small-section-header"><a href="#variant.ResponseParseError" class="anchor field"></a><span id='ResponseParseError.v' class='invisible'><code>ResponseParseError(HttpResponseParserError)</code></span></span><div class='docblock'><p>Response parsing error</p>
|
||||
</div><span id="variant.SendRequest" class="variant small-section-header"><a href="#variant.SendRequest" class="anchor field"></a><span id='SendRequest.v' class='invisible'><code>SendRequest(<a class="enum" href="../../actix_web/client/enum.SendRequestError.html" title="enum actix_web::client::SendRequestError">SendRequestError</a>)</code></span></span><div class='docblock'><p>Send request error</p>
|
||||
</div><span id="variant.Protocol" class="variant small-section-header"><a href="#variant.Protocol" class="anchor field"></a><span id='Protocol.v' class='invisible'><code>Protocol(<a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a>)</code></span></span><div class='docblock'><p>Protocol error</p>
|
||||
</div><span id="variant.Io" class="variant small-section-header"><a href="#variant.Io" class="anchor field"></a><span id='Io.v' class='invisible'><code>Io(<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>)</code></span></span><div class='docblock'><p>IO Error</p>
|
||||
</div><span id="variant.Disconnected" class="variant small-section-header"><a href="#variant.Disconnected" class="anchor field"></a><span id='Disconnected.v' class='invisible'><code>Disconnected</code></span></span><div class='docblock'><p>"Disconnected"</p>
|
||||
</div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-Fail' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl Fail for <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code><a href='#impl-Fail' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#35' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.cause' class="method"><span id='cause.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.cause' class='fnname'>cause</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&Fail></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#35' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors. <a href="#method.cause">Read more</a></p>
|
||||
</div><h4 id='method.backtrace' class="method"><span id='backtrace.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.backtrace' class='fnname'>backtrace</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&Backtrace></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#35' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the <code>Backtrace</code> carried by this failure, if it carries one. <a href="#method.backtrace">Read more</a></p>
|
||||
</div><h4 id='method.context' class="method"><span id='context.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.context' class='fnname'>context</a><D>(self, context: D) -> Context<D> <span class="where fmt-newline">where<br> D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Provides context for this failure. <a href="#method.context">Read more</a></p>
|
||||
</div><h4 id='method.compat' class="method"><span id='compat.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.compat' class='fnname'>compat</a>(self) -> Compat<Self></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Wraps this failure in a compatibility wrapper that implements <code>std::error::Error</code>. <a href="#method.compat">Read more</a></p>
|
||||
</div><h4 id='method.causes' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for Causes<'f></span></div><div class="content hidden"><h3 class="important">Important traits for Causes<'f></h3><code class="content"><span class="where fmt-newline">impl<'f> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for Causes<'f></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &'f (Fail + 'static);</span></code></div></div><span id='causes.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.causes' class='fnname'>causes</a>(&self) -> Causes</code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a iterator over the causes of this <code>Fail</code> with itself as the first item and the <code>root_cause</code> as the final item. <a href="#method.causes">Read more</a></p>
|
||||
</div><h4 id='method.root_cause' class="method"><span id='root_cause.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.root_cause' class='fnname'>root_cause</a>(&self) -> &(Fail + 'static)</code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the "root cause" of this <code>Fail</code> - the last value in the cause chain which does not return an underlying <code>cause</code>. <a href="#method.root_cause">Read more</a></p>
|
||||
</div></div><h3 id='impl-Display' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code><a href='#impl-Display' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#35' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#35' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#35' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#35' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id='impl-From%3CError%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../actix_web/error/struct.Error.html" title="struct actix_web::error::Error">Error</a>> for <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code><a href='#impl-From%3CError%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#81-85' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(err: <a class="struct" href="../../actix_web/error/struct.Error.html" title="struct actix_web::error::Error">Error</a>) -> <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#82-84' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id='impl-From%3CUrlParseError%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="../../actix_web/error/enum.UrlParseError.html" title="enum actix_web::error::UrlParseError">UrlParseError</a>> for <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code><a href='#impl-From%3CUrlParseError%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#87-91' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(err: <a class="enum" href="../../actix_web/error/enum.UrlParseError.html" title="enum actix_web::error::UrlParseError">UrlParseError</a>) -> <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#88-90' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id='impl-From%3CSendRequestError%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="../../actix_web/client/enum.SendRequestError.html" title="enum actix_web::client::SendRequestError">SendRequestError</a>> for <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code><a href='#impl-From%3CSendRequestError%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#93-97' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from-2' class="method"><span id='from.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(err: <a class="enum" href="../../actix_web/client/enum.SendRequestError.html" title="enum actix_web::client::SendRequestError">SendRequestError</a>) -> <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#94-96' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id='impl-From%3CProtocolError%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a>> for <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code><a href='#impl-From%3CProtocolError%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#99-103' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from-3' class="method"><span id='from.v-3' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(err: <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a>) -> <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#100-102' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id='impl-From%3CError%3E-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</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>> for <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code><a href='#impl-From%3CError%3E-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#105-109' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from-4' class="method"><span id='from.v-4' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(err: <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>) -> <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#106-108' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
79
static/api/actix-web/0.7.0/stable/ws/enum.CloseCode.html
Normal file
79
static/api/actix-web/0.7.0/stable/ws/enum.CloseCode.html
Normal file
@ -0,0 +1,79 @@
|
||||
<!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 `CloseCode` enum in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, CloseCode"><title>actix_web::ws::CloseCode - 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 enum"><!--[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'>Enum CloseCode</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Normal">Normal</a><a href="#variant.Away">Away</a><a href="#variant.Protocol">Protocol</a><a href="#variant.Unsupported">Unsupported</a><a href="#variant.Abnormal">Abnormal</a><a href="#variant.Invalid">Invalid</a><a href="#variant.Policy">Policy</a><a href="#variant.Size">Size</a><a href="#variant.Extension">Extension</a><a href="#variant.Error">Error</a><a href="#variant.Restart">Restart</a><a href="#variant.Again">Again</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Eq">Eq</a><a href="#impl-PartialEq">PartialEq</a><a href="#impl-Clone">Clone</a><a href="#impl-Copy">Copy</a><a href="#impl-Into%3Cu16%3E">Into<u16></a><a href="#impl-From%3Cu16%3E">From<u16></a><a href="#impl-From%3CCloseCode%3E">From<CloseCode></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'CloseCode', ty: 'enum', 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'>Enum <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="enum" href=''>CloseCode</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><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#78-138' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum CloseCode {
|
||||
Normal,
|
||||
Away,
|
||||
Protocol,
|
||||
Unsupported,
|
||||
Abnormal,
|
||||
Invalid,
|
||||
Policy,
|
||||
Size,
|
||||
Extension,
|
||||
Error,
|
||||
Restart,
|
||||
Again,
|
||||
// some variants omitted
|
||||
}</pre></div><div class='docblock'><p>Status code used to indicate why an endpoint is closing the <code>WebSocket</code>
|
||||
connection.</p>
|
||||
</div><h2 id='variants' class='variants small-section-header'>
|
||||
Variants<a href='#variants' class='anchor'></a></h2>
|
||||
<span id="variant.Normal" class="variant small-section-header"><a href="#variant.Normal" class="anchor field"></a><span id='Normal.v' class='invisible'><code>Normal</code></span></span><div class='docblock'><p>Indicates a normal closure, meaning that the purpose for
|
||||
which the connection was established has been fulfilled.</p>
|
||||
</div><span id="variant.Away" class="variant small-section-header"><a href="#variant.Away" class="anchor field"></a><span id='Away.v' class='invisible'><code>Away</code></span></span><div class='docblock'><p>Indicates that an endpoint is "going away", such as a server
|
||||
going down or a browser having navigated away from a page.</p>
|
||||
</div><span id="variant.Protocol" class="variant small-section-header"><a href="#variant.Protocol" class="anchor field"></a><span id='Protocol.v' class='invisible'><code>Protocol</code></span></span><div class='docblock'><p>Indicates that an endpoint is terminating the connection due
|
||||
to a protocol error.</p>
|
||||
</div><span id="variant.Unsupported" class="variant small-section-header"><a href="#variant.Unsupported" class="anchor field"></a><span id='Unsupported.v' class='invisible'><code>Unsupported</code></span></span><div class='docblock'><p>Indicates that an endpoint is terminating the connection
|
||||
because it has received a type of data it cannot accept (e.g., an
|
||||
endpoint that understands only text data MAY send this if it
|
||||
receives a binary message).</p>
|
||||
</div><span id="variant.Abnormal" class="variant small-section-header"><a href="#variant.Abnormal" class="anchor field"></a><span id='Abnormal.v' class='invisible'><code>Abnormal</code></span></span><div class='docblock'><p>Indicates an abnormal closure. If the abnormal closure was due to an
|
||||
error, this close code will not be used. Instead, the <code>on_error</code> method
|
||||
of the handler will be called with the error. However, if the connection
|
||||
is simply dropped, without an error, this close code will be sent to the
|
||||
handler.</p>
|
||||
</div><span id="variant.Invalid" class="variant small-section-header"><a href="#variant.Invalid" class="anchor field"></a><span id='Invalid.v' class='invisible'><code>Invalid</code></span></span><div class='docblock'><p>Indicates that an endpoint is terminating the connection
|
||||
because it has received data within a message that was not
|
||||
consistent with the type of the message (e.g., non-UTF-8 [RFC3629]
|
||||
data within a text message).</p>
|
||||
</div><span id="variant.Policy" class="variant small-section-header"><a href="#variant.Policy" class="anchor field"></a><span id='Policy.v' class='invisible'><code>Policy</code></span></span><div class='docblock'><p>Indicates that an endpoint is terminating the connection
|
||||
because it has received a message that violates its policy. This
|
||||
is a generic status code that can be returned when there is no
|
||||
other more suitable status code (e.g., Unsupported or Size) or if there
|
||||
is a need to hide specific details about the policy.</p>
|
||||
</div><span id="variant.Size" class="variant small-section-header"><a href="#variant.Size" class="anchor field"></a><span id='Size.v' class='invisible'><code>Size</code></span></span><div class='docblock'><p>Indicates that an endpoint is terminating the connection
|
||||
because it has received a message that is too big for it to
|
||||
process.</p>
|
||||
</div><span id="variant.Extension" class="variant small-section-header"><a href="#variant.Extension" class="anchor field"></a><span id='Extension.v' class='invisible'><code>Extension</code></span></span><div class='docblock'><p>Indicates that an endpoint (client) is terminating the
|
||||
connection because it has expected the server to negotiate one or
|
||||
more extension, but the server didn't return them in the response
|
||||
message of the WebSocket handshake. The list of extensions that
|
||||
are needed should be given as the reason for closing.
|
||||
Note that this status code is not used by the server, because it
|
||||
can fail the WebSocket handshake instead.</p>
|
||||
</div><span id="variant.Error" class="variant small-section-header"><a href="#variant.Error" class="anchor field"></a><span id='Error.v' class='invisible'><code>Error</code></span></span><div class='docblock'><p>Indicates that a server is terminating the connection because
|
||||
it encountered an unexpected condition that prevented it from
|
||||
fulfilling the request.</p>
|
||||
</div><span id="variant.Restart" class="variant small-section-header"><a href="#variant.Restart" class="anchor field"></a><span id='Restart.v' class='invisible'><code>Restart</code></span></span><div class='docblock'><p>Indicates that the server is restarting. A client may choose to
|
||||
reconnect, and if it does, it should use a randomized delay of 5-30
|
||||
seconds between attempts.</p>
|
||||
</div><span id="variant.Again" class="variant small-section-header"><a href="#variant.Again" class="anchor field"></a><span id='Again.v' class='invisible'><code>Again</code></span></span><div class='docblock'><p>Indicates that the server is overloaded and the client should either
|
||||
connect to a different IP (when multiple targets exist), or
|
||||
reconnect to the same IP when a user has performed an action.</p>
|
||||
</div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#77' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#77' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id='impl-Eq' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a></code><a href='#impl-Eq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#77' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-PartialEq' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a></code><a href='#impl-PartialEq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#77' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, other: &<a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#77' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||||
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, other: &<a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#77' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
||||
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#77' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#77' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||||
</div></div><h3 id='impl-Copy' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a></code><a href='#impl-Copy' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#77' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Into%3Cu16%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>> for <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a></code><a href='#impl-Into%3Cu16%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#140-159' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.into' class="method"><span id='into.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#141-158' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id='impl-From%3Cu16%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>> for <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a></code><a href='#impl-From%3Cu16%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#161-180' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(code: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>) -> <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#162-179' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id='impl-From%3CCloseCode%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a>> for <a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a></code><a href='#impl-From%3CCloseCode%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#191-198' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(code: <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#192-197' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
@ -0,0 +1,38 @@
|
||||
<!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 `HandshakeError` enum in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, HandshakeError"><title>actix_web::ws::HandshakeError - 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 enum"><!--[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'>Enum HandshakeError</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.GetMethodRequired">GetMethodRequired</a><a href="#variant.NoWebsocketUpgrade">NoWebsocketUpgrade</a><a href="#variant.NoConnectionUpgrade">NoConnectionUpgrade</a><a href="#variant.NoVersionHeader">NoVersionHeader</a><a href="#variant.UnsupportedVersion">UnsupportedVersion</a><a href="#variant.BadWebsocketKey">BadWebsocketKey</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Fail">Fail</a><a href="#impl-Display">Display</a><a href="#impl-PartialEq">PartialEq</a><a href="#impl-Debug">Debug</a><a href="#impl-ResponseError">ResponseError</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'HandshakeError', ty: 'enum', 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'>Enum <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="enum" href=''>HandshakeError</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><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#112-131' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum HandshakeError {
|
||||
GetMethodRequired,
|
||||
NoWebsocketUpgrade,
|
||||
NoConnectionUpgrade,
|
||||
NoVersionHeader,
|
||||
UnsupportedVersion,
|
||||
BadWebsocketKey,
|
||||
}</pre></div><div class='docblock'><p>Websocket handshake errors</p>
|
||||
</div><h2 id='variants' class='variants small-section-header'>
|
||||
Variants<a href='#variants' class='anchor'></a></h2>
|
||||
<span id="variant.GetMethodRequired" class="variant small-section-header"><a href="#variant.GetMethodRequired" class="anchor field"></a><span id='GetMethodRequired.v' class='invisible'><code>GetMethodRequired</code></span></span><div class='docblock'><p>Only get method is allowed</p>
|
||||
</div><span id="variant.NoWebsocketUpgrade" class="variant small-section-header"><a href="#variant.NoWebsocketUpgrade" class="anchor field"></a><span id='NoWebsocketUpgrade.v' class='invisible'><code>NoWebsocketUpgrade</code></span></span><div class='docblock'><p>Upgrade header if not set to websocket</p>
|
||||
</div><span id="variant.NoConnectionUpgrade" class="variant small-section-header"><a href="#variant.NoConnectionUpgrade" class="anchor field"></a><span id='NoConnectionUpgrade.v' class='invisible'><code>NoConnectionUpgrade</code></span></span><div class='docblock'><p>Connection header is not set to upgrade</p>
|
||||
</div><span id="variant.NoVersionHeader" class="variant small-section-header"><a href="#variant.NoVersionHeader" class="anchor field"></a><span id='NoVersionHeader.v' class='invisible'><code>NoVersionHeader</code></span></span><div class='docblock'><p>Websocket version header is not set</p>
|
||||
</div><span id="variant.UnsupportedVersion" class="variant small-section-header"><a href="#variant.UnsupportedVersion" class="anchor field"></a><span id='UnsupportedVersion.v' class='invisible'><code>UnsupportedVersion</code></span></span><div class='docblock'><p>Unsupported websocket version</p>
|
||||
</div><span id="variant.BadWebsocketKey" class="variant small-section-header"><a href="#variant.BadWebsocketKey" class="anchor field"></a><span id='BadWebsocketKey.v' class='invisible'><code>BadWebsocketKey</code></span></span><div class='docblock'><p>Websocket key is not set or wrong</p>
|
||||
</div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-Fail' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl Fail for <a class="enum" href="../../actix_web/ws/enum.HandshakeError.html" title="enum actix_web::ws::HandshakeError">HandshakeError</a></code><a href='#impl-Fail' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#111' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.cause' class="method"><span id='cause.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.cause' class='fnname'>cause</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&Fail></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#111' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors. <a href="#method.cause">Read more</a></p>
|
||||
</div><h4 id='method.backtrace' class="method"><span id='backtrace.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.backtrace' class='fnname'>backtrace</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&Backtrace></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#111' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the <code>Backtrace</code> carried by this failure, if it carries one. <a href="#method.backtrace">Read more</a></p>
|
||||
</div><h4 id='method.context' class="method"><span id='context.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.context' class='fnname'>context</a><D>(self, context: D) -> Context<D> <span class="where fmt-newline">where<br> D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Provides context for this failure. <a href="#method.context">Read more</a></p>
|
||||
</div><h4 id='method.compat' class="method"><span id='compat.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.compat' class='fnname'>compat</a>(self) -> Compat<Self></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Wraps this failure in a compatibility wrapper that implements <code>std::error::Error</code>. <a href="#method.compat">Read more</a></p>
|
||||
</div><h4 id='method.causes' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for Causes<'f></span></div><div class="content hidden"><h3 class="important">Important traits for Causes<'f></h3><code class="content"><span class="where fmt-newline">impl<'f> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for Causes<'f></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &'f (Fail + 'static);</span></code></div></div><span id='causes.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.causes' class='fnname'>causes</a>(&self) -> Causes</code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a iterator over the causes of this <code>Fail</code> with itself as the first item and the <code>root_cause</code> as the final item. <a href="#method.causes">Read more</a></p>
|
||||
</div><h4 id='method.root_cause' class="method"><span id='root_cause.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.root_cause' class='fnname'>root_cause</a>(&self) -> &(Fail + 'static)</code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the "root cause" of this <code>Fail</code> - the last value in the cause chain which does not return an underlying <code>cause</code>. <a href="#method.root_cause">Read more</a></p>
|
||||
</div></div><h3 id='impl-Display' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="../../actix_web/ws/enum.HandshakeError.html" title="enum actix_web::ws::HandshakeError">HandshakeError</a></code><a href='#impl-Display' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#111' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#111' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id='impl-PartialEq' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="../../actix_web/ws/enum.HandshakeError.html" title="enum actix_web::ws::HandshakeError">HandshakeError</a></code><a href='#impl-PartialEq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#111' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, other: &<a class="enum" href="../../actix_web/ws/enum.HandshakeError.html" title="enum actix_web::ws::HandshakeError">HandshakeError</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#111' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||||
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><table class='table-display'><tbody><tr><td><code><div class="docblock attributes">#[must_use]
|
||||
</div>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#126' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
||||
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../actix_web/ws/enum.HandshakeError.html" title="enum actix_web::ws::HandshakeError">HandshakeError</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#111' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#111' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id='impl-ResponseError' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../actix_web/error/trait.ResponseError.html" title="trait actix_web::error::ResponseError">ResponseError</a> for <a class="enum" href="../../actix_web/ws/enum.HandshakeError.html" title="enum actix_web::ws::HandshakeError">HandshakeError</a></code><a href='#impl-ResponseError' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#133-156' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.error_response' class="method"><span id='error_response.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/error/trait.ResponseError.html#method.error_response' class='fnname'>error_response</a>(&self) -> <a class="struct" href="../../actix_web/struct.HttpResponse.html" title="struct actix_web::HttpResponse">HttpResponse</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#134-155' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create response for error <a href="../../actix_web/error/trait.ResponseError.html#method.error_response">Read more</a></p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../../actix_web/ws/enum.HandshakeError.html" title="enum actix_web::ws::HandshakeError">HandshakeError</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../../actix_web/ws/enum.HandshakeError.html" title="enum actix_web::ws::HandshakeError">HandshakeError</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
29
static/api/actix-web/0.7.0/stable/ws/enum.Message.html
Normal file
29
static/api/actix-web/0.7.0/stable/ws/enum.Message.html
Normal file
@ -0,0 +1,29 @@
|
||||
<!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 `Message` enum in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, Message"><title>actix_web::ws::Message - 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 enum"><!--[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'>Enum Message</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Text">Text</a><a href="#variant.Binary">Binary</a><a href="#variant.Ping">Ping</a><a href="#variant.Pong">Pong</a><a href="#variant.Close">Close</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Message">Message</a><a href="#impl-Debug">Debug</a><a href="#impl-PartialEq">PartialEq</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'Message', ty: 'enum', 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'>Enum <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="enum" href=''>Message</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><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#160-171' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum Message {
|
||||
Text(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
|
||||
Binary(<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>),
|
||||
Ping(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
|
||||
Pong(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
|
||||
Close(<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a>>),
|
||||
}</pre></div><div class='docblock'><p><code>WebSocket</code> Message</p>
|
||||
</div><h2 id='variants' class='variants small-section-header'>
|
||||
Variants<a href='#variants' class='anchor'></a></h2>
|
||||
<span id="variant.Text" class="variant small-section-header"><a href="#variant.Text" class="anchor field"></a><span id='Text.v' class='invisible'><code>Text(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>Text message</p>
|
||||
</div><span id="variant.Binary" class="variant small-section-header"><a href="#variant.Binary" class="anchor field"></a><span id='Binary.v' class='invisible'><code>Binary(<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>)</code></span></span><div class='docblock'><p>Binary message</p>
|
||||
</div><span id="variant.Ping" class="variant small-section-header"><a href="#variant.Ping" class="anchor field"></a><span id='Ping.v' class='invisible'><code>Ping(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>Ping message</p>
|
||||
</div><span id="variant.Pong" class="variant small-section-header"><a href="#variant.Pong" class="anchor field"></a><span id='Pong.v' class='invisible'><code>Pong(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>Pong message</p>
|
||||
</div><span id="variant.Close" class="variant small-section-header"><a href="#variant.Close" class="anchor field"></a><span id='Close.v' class='invisible'><code>Close(<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a>>)</code></span></span><div class='docblock'><p>Close message with optional reason</p>
|
||||
</div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-Message' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../actix_web/actix/actix/dev/trait.Message.html" title="trait actix_web::actix::actix::dev::Message">Message</a> for <a class="enum" href="../../actix_web/ws/enum.Message.html" title="enum actix_web::ws::Message">Message</a></code><a href='#impl-Message' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#159' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Result' class="type"><span id='Result.t' class='invisible'><code>type <a href='../../actix_web/actix/actix/dev/trait.Message.html#associatedtype.Result' class="type">Result</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></span></h4>
|
||||
<div class='docblock'><p>The type of value that this message will resolved with if it is successful. <a href="../../actix_web/actix/actix/dev/trait.Message.html#associatedtype.Result">Read more</a></p>
|
||||
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../actix_web/ws/enum.Message.html" title="enum actix_web::ws::Message">Message</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#159' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#159' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id='impl-PartialEq' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="../../actix_web/ws/enum.Message.html" title="enum actix_web::ws::Message">Message</a></code><a href='#impl-PartialEq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#159' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, other: &<a class="enum" href="../../actix_web/ws/enum.Message.html" title="enum actix_web::ws::Message">Message</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#159' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||||
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, other: &<a class="enum" href="../../actix_web/ws/enum.Message.html" title="enum actix_web::ws::Message">Message</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#159' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../../actix_web/ws/enum.Message.html" title="enum actix_web::ws::Message">Message</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../../actix_web/ws/enum.Message.html" title="enum actix_web::ws::Message">Message</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
37
static/api/actix-web/0.7.0/stable/ws/enum.OpCode.html
Normal file
37
static/api/actix-web/0.7.0/stable/ws/enum.OpCode.html
Normal file
@ -0,0 +1,37 @@
|
||||
<!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 `OpCode` enum in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, OpCode"><title>actix_web::ws::OpCode - 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 enum"><!--[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'>Enum OpCode</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Continue">Continue</a><a href="#variant.Text">Text</a><a href="#variant.Binary">Binary</a><a href="#variant.Close">Close</a><a href="#variant.Ping">Ping</a><a href="#variant.Pong">Pong</a><a href="#variant.Bad">Bad</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Eq">Eq</a><a href="#impl-PartialEq">PartialEq</a><a href="#impl-Clone">Clone</a><a href="#impl-Copy">Copy</a><a href="#impl-Display">Display</a><a href="#impl-Into%3Cu8%3E">Into<u8></a><a href="#impl-From%3Cu8%3E">From<u8></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'OpCode', ty: 'enum', 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'>Enum <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="enum" href=''>OpCode</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><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#9-24' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum OpCode {
|
||||
Continue,
|
||||
Text,
|
||||
Binary,
|
||||
Close,
|
||||
Ping,
|
||||
Pong,
|
||||
Bad,
|
||||
}</pre></div><div class='docblock'><p>Operation codes as part of rfc6455.</p>
|
||||
</div><h2 id='variants' class='variants small-section-header'>
|
||||
Variants<a href='#variants' class='anchor'></a></h2>
|
||||
<span id="variant.Continue" class="variant small-section-header"><a href="#variant.Continue" class="anchor field"></a><span id='Continue.v' class='invisible'><code>Continue</code></span></span><div class='docblock'><p>Indicates a continuation frame of a fragmented message.</p>
|
||||
</div><span id="variant.Text" class="variant small-section-header"><a href="#variant.Text" class="anchor field"></a><span id='Text.v' class='invisible'><code>Text</code></span></span><div class='docblock'><p>Indicates a text data frame.</p>
|
||||
</div><span id="variant.Binary" class="variant small-section-header"><a href="#variant.Binary" class="anchor field"></a><span id='Binary.v' class='invisible'><code>Binary</code></span></span><div class='docblock'><p>Indicates a binary data frame.</p>
|
||||
</div><span id="variant.Close" class="variant small-section-header"><a href="#variant.Close" class="anchor field"></a><span id='Close.v' class='invisible'><code>Close</code></span></span><div class='docblock'><p>Indicates a close control frame.</p>
|
||||
</div><span id="variant.Ping" class="variant small-section-header"><a href="#variant.Ping" class="anchor field"></a><span id='Ping.v' class='invisible'><code>Ping</code></span></span><div class='docblock'><p>Indicates a ping control frame.</p>
|
||||
</div><span id="variant.Pong" class="variant small-section-header"><a href="#variant.Pong" class="anchor field"></a><span id='Pong.v' class='invisible'><code>Pong</code></span></span><div class='docblock'><p>Indicates a pong control frame.</p>
|
||||
</div><span id="variant.Bad" class="variant small-section-header"><a href="#variant.Bad" class="anchor field"></a><span id='Bad.v' class='invisible'><code>Bad</code></span></span><div class='docblock'><p>Indicates an invalid opcode was received.</p>
|
||||
</div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#8' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#8' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id='impl-Eq' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a></code><a href='#impl-Eq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#8' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-PartialEq' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a></code><a href='#impl-PartialEq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#8' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, other: &<a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#8' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||||
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><table class='table-display'><tbody><tr><td><code><div class="docblock attributes">#[must_use]
|
||||
</div>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#126' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
||||
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#8' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#8' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||||
</div></div><h3 id='impl-Copy' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a></code><a href='#impl-Copy' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#8' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Display' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a></code><a href='#impl-Display' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#26-38' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#27-37' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id='impl-Into%3Cu8%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>> for <a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a></code><a href='#impl-Into%3Cu8%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#40-58' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.into' class="method"><span id='into.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#41-57' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id='impl-From%3Cu8%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>> for <a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a></code><a href='#impl-From%3Cu8%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#60-72' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(byte: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#61-71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
43
static/api/actix-web/0.7.0/stable/ws/enum.ProtocolError.html
Normal file
43
static/api/actix-web/0.7.0/stable/ws/enum.ProtocolError.html
Normal file
@ -0,0 +1,43 @@
|
||||
<!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 `ProtocolError` enum in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, ProtocolError"><title>actix_web::ws::ProtocolError - 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 enum"><!--[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'>Enum ProtocolError</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.UnmaskedFrame">UnmaskedFrame</a><a href="#variant.MaskedFrame">MaskedFrame</a><a href="#variant.InvalidOpcode">InvalidOpcode</a><a href="#variant.InvalidLength">InvalidLength</a><a href="#variant.BadOpCode">BadOpCode</a><a href="#variant.Overflow">Overflow</a><a href="#variant.NoContinuation">NoContinuation</a><a href="#variant.BadEncoding">BadEncoding</a><a href="#variant.Payload">Payload</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-From%3CProtocolError%3E">From<ProtocolError></a><a href="#impl-Fail">Fail</a><a href="#impl-Display">Display</a><a href="#impl-Debug">Debug</a><a href="#impl-ResponseError">ResponseError</a><a href="#impl-From%3CPayloadError%3E">From<PayloadError></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'ProtocolError', ty: 'enum', 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'>Enum <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="enum" href=''>ProtocolError</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><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#72-100' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum ProtocolError {
|
||||
UnmaskedFrame,
|
||||
MaskedFrame,
|
||||
InvalidOpcode(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>),
|
||||
InvalidLength(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>),
|
||||
BadOpCode,
|
||||
Overflow,
|
||||
NoContinuation,
|
||||
BadEncoding,
|
||||
Payload(<a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>),
|
||||
}</pre></div><div class='docblock'><p>Websocket protocol errors</p>
|
||||
</div><h2 id='variants' class='variants small-section-header'>
|
||||
Variants<a href='#variants' class='anchor'></a></h2>
|
||||
<span id="variant.UnmaskedFrame" class="variant small-section-header"><a href="#variant.UnmaskedFrame" class="anchor field"></a><span id='UnmaskedFrame.v' class='invisible'><code>UnmaskedFrame</code></span></span><div class='docblock'><p>Received an unmasked frame from client</p>
|
||||
</div><span id="variant.MaskedFrame" class="variant small-section-header"><a href="#variant.MaskedFrame" class="anchor field"></a><span id='MaskedFrame.v' class='invisible'><code>MaskedFrame</code></span></span><div class='docblock'><p>Received a masked frame from server</p>
|
||||
</div><span id="variant.InvalidOpcode" class="variant small-section-header"><a href="#variant.InvalidOpcode" class="anchor field"></a><span id='InvalidOpcode.v' class='invisible'><code>InvalidOpcode(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code></span></span><div class='docblock'><p>Encountered invalid opcode</p>
|
||||
</div><span id="variant.InvalidLength" class="variant small-section-header"><a href="#variant.InvalidLength" class="anchor field"></a><span id='InvalidLength.v' class='invisible'><code>InvalidLength(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code></span></span><div class='docblock'><p>Invalid control frame length</p>
|
||||
</div><span id="variant.BadOpCode" class="variant small-section-header"><a href="#variant.BadOpCode" class="anchor field"></a><span id='BadOpCode.v' class='invisible'><code>BadOpCode</code></span></span><div class='docblock'><p>Bad web socket op code</p>
|
||||
</div><span id="variant.Overflow" class="variant small-section-header"><a href="#variant.Overflow" class="anchor field"></a><span id='Overflow.v' class='invisible'><code>Overflow</code></span></span><div class='docblock'><p>A payload reached size limit.</p>
|
||||
</div><span id="variant.NoContinuation" class="variant small-section-header"><a href="#variant.NoContinuation" class="anchor field"></a><span id='NoContinuation.v' class='invisible'><code>NoContinuation</code></span></span><div class='docblock'><p>Continuation is not supported</p>
|
||||
</div><span id="variant.BadEncoding" class="variant small-section-header"><a href="#variant.BadEncoding" class="anchor field"></a><span id='BadEncoding.v' class='invisible'><code>BadEncoding</code></span></span><div class='docblock'><p>Bad utf-8 encoding</p>
|
||||
</div><span id="variant.Payload" class="variant small-section-header"><a href="#variant.Payload" class="anchor field"></a><span id='Payload.v' class='invisible'><code>Payload(<a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>)</code></span></span><div class='docblock'><p>Payload error</p>
|
||||
</div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-From%3CProtocolError%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a>> for <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code><a href='#impl-From%3CProtocolError%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#99-103' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(err: <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a>) -> <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#100-102' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id='impl-Fail' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl Fail for <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a></code><a href='#impl-Fail' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#71' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.cause' class="method"><span id='cause.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.cause' class='fnname'>cause</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&Fail></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors. <a href="#method.cause">Read more</a></p>
|
||||
</div><h4 id='method.backtrace' class="method"><span id='backtrace.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.backtrace' class='fnname'>backtrace</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&Backtrace></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the <code>Backtrace</code> carried by this failure, if it carries one. <a href="#method.backtrace">Read more</a></p>
|
||||
</div><h4 id='method.context' class="method"><span id='context.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.context' class='fnname'>context</a><D>(self, context: D) -> Context<D> <span class="where fmt-newline">where<br> D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Provides context for this failure. <a href="#method.context">Read more</a></p>
|
||||
</div><h4 id='method.compat' class="method"><span id='compat.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.compat' class='fnname'>compat</a>(self) -> Compat<Self></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Wraps this failure in a compatibility wrapper that implements <code>std::error::Error</code>. <a href="#method.compat">Read more</a></p>
|
||||
</div><h4 id='method.causes' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for Causes<'f></span></div><div class="content hidden"><h3 class="important">Important traits for Causes<'f></h3><code class="content"><span class="where fmt-newline">impl<'f> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for Causes<'f></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &'f (Fail + 'static);</span></code></div></div><span id='causes.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.causes' class='fnname'>causes</a>(&self) -> Causes</code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a iterator over the causes of this <code>Fail</code> with itself as the first item and the <code>root_cause</code> as the final item. <a href="#method.causes">Read more</a></p>
|
||||
</div><h4 id='method.root_cause' class="method"><span id='root_cause.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.root_cause' class='fnname'>root_cause</a>(&self) -> &(Fail + 'static)</code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the "root cause" of this <code>Fail</code> - the last value in the cause chain which does not return an underlying <code>cause</code>. <a href="#method.root_cause">Read more</a></p>
|
||||
</div></div><h3 id='impl-Display' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a></code><a href='#impl-Display' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#71' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#71' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id='impl-ResponseError' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../actix_web/error/trait.ResponseError.html" title="trait actix_web::error::ResponseError">ResponseError</a> for <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a></code><a href='#impl-ResponseError' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#102' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.error_response' class="method"><span id='error_response.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/error/trait.ResponseError.html#method.error_response' class='fnname'>error_response</a>(&self) -> <a class="struct" href="../../actix_web/struct.HttpResponse.html" title="struct actix_web::HttpResponse">HttpResponse</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/error.rs.html#145-147' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create response for error <a href="../../actix_web/error/trait.ResponseError.html#method.error_response">Read more</a></p>
|
||||
</div></div><h3 id='impl-From%3CPayloadError%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>> for <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a></code><a href='#impl-From%3CPayloadError%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#104-108' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(err: <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>) -> <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#105-107' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
4
static/api/actix-web/0.7.0/stable/ws/fn.handshake.html
Normal file
4
static/api/actix-web/0.7.0/stable/ws/fn.handshake.html
Normal file
@ -0,0 +1,4 @@
|
||||
<!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 `handshake` fn in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, handshake"><title>actix_web::ws::handshake - 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 fn"><!--[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><div class="sidebar-elems"><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'handshake', ty: 'fn', 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'>Function <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="fn" href=''>handshake</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><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#194-251' title='goto source code'>[src]</a></span></h1><pre class='rust fn'>pub fn handshake<S>(<br> req: &<a class="struct" href="../../actix_web/struct.HttpRequest.html" title="struct actix_web::HttpRequest">HttpRequest</a><S><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../actix_web/dev/struct.HttpResponseBuilder.html" title="struct actix_web::dev::HttpResponseBuilder">HttpResponseBuilder</a>, <a class="enum" href="../../actix_web/ws/enum.HandshakeError.html" title="enum actix_web::ws::HandshakeError">HandshakeError</a>></pre><div class='docblock'><p>Prepare <code>WebSocket</code> handshake response.</p>
|
||||
<p>This function returns handshake <code>HttpResponse</code>, ready to send to peer.
|
||||
It does not perform any IO.</p>
|
||||
</div></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>
|
||||
2
static/api/actix-web/0.7.0/stable/ws/fn.start.html
Normal file
2
static/api/actix-web/0.7.0/stable/ws/fn.start.html
Normal file
@ -0,0 +1,2 @@
|
||||
<!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 `start` fn in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, start"><title>actix_web::ws::start - 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 fn"><!--[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><div class="sidebar-elems"><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'start', ty: 'fn', 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'>Function <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="fn" href=''>start</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><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#174-184' title='goto source code'>[src]</a></span></h1><pre class='rust fn'>pub fn start<A, S>(<br> req: &<a class="struct" href="../../actix_web/struct.HttpRequest.html" title="struct actix_web::HttpRequest">HttpRequest</a><S>, <br> actor: A<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../actix_web/struct.HttpResponse.html" title="struct actix_web::HttpResponse">HttpResponse</a>, <a class="struct" href="../../actix_web/error/struct.Error.html" title="struct actix_web::error::Error">Error</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><Context = <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S>> + <a class="trait" href="../../actix_web/actix/actix/dev/trait.StreamHandler.html" title="trait actix_web::actix::actix::dev::StreamHandler">StreamHandler</a><<a class="enum" href="../../actix_web/ws/enum.Message.html" title="enum actix_web::ws::Message">Message</a>, <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a>>,<br> S: 'static, </span></pre><div class='docblock'><p>Do websocket handshake and start actor</p>
|
||||
</div></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>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/frame/Frame.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/frame/Frame.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.Frame.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.Frame.html">struct.Frame.html</a>...</p>
|
||||
<script>location.replace("struct.Frame.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.FramedMessage.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.FramedMessage.html">struct.FramedMessage.html</a>...</p>
|
||||
<script>location.replace("struct.FramedMessage.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/frame/struct.Frame.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/frame/struct.Frame.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../actix_web/ws/struct.Frame.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../actix_web/ws/struct.Frame.html">../../../actix_web/ws/struct.Frame.html</a>...</p>
|
||||
<script>location.replace("../../../actix_web/ws/struct.Frame.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../actix_web/ws/struct.FramedMessage.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../actix_web/ws/struct.FramedMessage.html">../../../actix_web/ws/struct.FramedMessage.html</a>...</p>
|
||||
<script>location.replace("../../../actix_web/ws/struct.FramedMessage.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/handshake.v.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/handshake.v.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=fn.handshake.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="fn.handshake.html">fn.handshake.html</a>...</p>
|
||||
<script>location.replace("fn.handshake.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
180
static/api/actix-web/0.7.0/stable/ws/index.html
Normal file
180
static/api/actix-web/0.7.0/stable/ws/index.html
Normal file
@ -0,0 +1,180 @@
|
||||
<!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 `ws` mod in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, ws"><title>actix_web::ws - 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 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><p class='location'>Module ws</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>actix_web</a></p><script>window.sidebarCurrent = {name: 'ws', ty: 'mod', 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'>Module <a href='../index.html'>actix_web</a>::<wbr><a class="mod" href=''>ws</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><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#1-489' title='goto source code'>[src]</a></span></h1><div class='docblock'><p><code>WebSocket</code> support for Actix</p>
|
||||
<p>To setup a <code>WebSocket</code>, first do web socket handshake then on success
|
||||
convert <code>Payload</code> into a <code>WsStream</code> stream and then use <code>WsWriter</code> to
|
||||
communicate with the peer.</p>
|
||||
<h2 id="example" class="section-header"><a href="#example">Example</a></h2>
|
||||
<pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">ws</span>, <span class="ident">HttpRequest</span>, <span class="ident">HttpResponse</span>};
|
||||
|
||||
<span class="comment">// do websocket handshake and start actor</span>
|
||||
<span class="kw">fn</span> <span class="ident">ws_index</span>(<span class="ident">req</span>: <span class="kw-2">&</span><span class="ident">HttpRequest</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">HttpResponse</span><span class="op">></span> {
|
||||
<span class="ident">ws</span>::<span class="ident">start</span>(<span class="ident">req</span>, <span class="ident">Ws</span>)
|
||||
}
|
||||
|
||||
<span class="kw">struct</span> <span class="ident">Ws</span>;
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Actor</span> <span class="kw">for</span> <span class="ident">Ws</span> {
|
||||
<span class="kw">type</span> <span class="ident">Context</span> <span class="op">=</span> <span class="ident">ws</span>::<span class="ident">WebsocketContext</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>;
|
||||
}
|
||||
|
||||
<span class="comment">// Handler for ws::Message messages</span>
|
||||
<span class="kw">impl</span> <span class="ident">StreamHandler</span><span class="op"><</span><span class="ident">ws</span>::<span class="ident">Message</span>, <span class="ident">ws</span>::<span class="ident">ProtocolError</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Ws</span> {
|
||||
<span class="kw">fn</span> <span class="ident">handle</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">msg</span>: <span class="ident">ws</span>::<span class="ident">Message</span>, <span class="ident">ctx</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">Self</span>::<span class="ident">Context</span>) {
|
||||
<span class="kw">match</span> <span class="ident">msg</span> {
|
||||
<span class="ident">ws</span>::<span class="ident">Message</span>::<span class="ident">Ping</span>(<span class="ident">msg</span>) <span class="op">=></span> <span class="ident">ctx</span>.<span class="ident">pong</span>(<span class="kw-2">&</span><span class="ident">msg</span>),
|
||||
<span class="ident">ws</span>::<span class="ident">Message</span>::<span class="ident">Text</span>(<span class="ident">text</span>) <span class="op">=></span> <span class="ident">ctx</span>.<span class="ident">text</span>(<span class="ident">text</span>),
|
||||
<span class="ident">ws</span>::<span class="ident">Message</span>::<span class="ident">Binary</span>(<span class="ident">bin</span>) <span class="op">=></span> <span class="ident">ctx</span>.<span class="ident">binary</span>(<span class="ident">bin</span>),
|
||||
<span class="kw">_</span> <span class="op">=></span> (),
|
||||
}
|
||||
}
|
||||
}</pre>
|
||||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||||
<table>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="struct" href="struct.Client.html"
|
||||
title='struct actix_web::ws::Client'>Client</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p><code>WebSocket</code> client</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="struct" href="struct.ClientHandshake.html"
|
||||
title='struct actix_web::ws::ClientHandshake'>ClientHandshake</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Future that implementes client websocket handshake process.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="struct" href="struct.ClientReader.html"
|
||||
title='struct actix_web::ws::ClientReader'>ClientReader</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Websocket reader client</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="struct" href="struct.ClientWriter.html"
|
||||
title='struct actix_web::ws::ClientWriter'>ClientWriter</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Websocket writer client</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="struct" href="struct.CloseReason.html"
|
||||
title='struct actix_web::ws::CloseReason'>CloseReason</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Reason for closing the connection</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="struct" href="struct.Frame.html"
|
||||
title='struct actix_web::ws::Frame'>Frame</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>A struct representing a <code>WebSocket</code> frame.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="struct" href="struct.FramedMessage.html"
|
||||
title='struct actix_web::ws::FramedMessage'>FramedMessage</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p><code>WebSocket</code> message with framing.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="struct" href="struct.WebsocketContext.html"
|
||||
title='struct actix_web::ws::WebsocketContext'>WebsocketContext</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Execution context for <code>WebSockets</code> actors</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="struct" href="struct.WsStream.html"
|
||||
title='struct actix_web::ws::WsStream'>WsStream</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Maps <code>Payload</code> stream into stream of <code>ws::Message</code> items</p>
|
||||
|
||||
</td>
|
||||
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||||
<table>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="enum" href="enum.ClientError.html"
|
||||
title='enum actix_web::ws::ClientError'>ClientError</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Websocket client error</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="enum" href="enum.CloseCode.html"
|
||||
title='enum actix_web::ws::CloseCode'>CloseCode</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Status code used to indicate why an endpoint is closing the <code>WebSocket</code>
|
||||
connection.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="enum" href="enum.HandshakeError.html"
|
||||
title='enum actix_web::ws::HandshakeError'>HandshakeError</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Websocket handshake errors</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="enum" href="enum.Message.html"
|
||||
title='enum actix_web::ws::Message'>Message</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p><code>WebSocket</code> Message</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="enum" href="enum.OpCode.html"
|
||||
title='enum actix_web::ws::OpCode'>OpCode</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Operation codes as part of rfc6455.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="enum" href="enum.ProtocolError.html"
|
||||
title='enum actix_web::ws::ProtocolError'>ProtocolError</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Websocket protocol errors</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.WsWriter.html"
|
||||
title='trait actix_web::ws::WsWriter'>WsWriter</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Common writing methods for a websocket.</p>
|
||||
|
||||
</td>
|
||||
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||||
<table>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="fn" href="fn.handshake.html"
|
||||
title='fn actix_web::ws::handshake'>handshake</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Prepare <code>WebSocket</code> handshake response.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="fn" href="fn.start.html"
|
||||
title='fn actix_web::ws::start'>start</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Do websocket handshake and start actor</p>
|
||||
|
||||
</td>
|
||||
</tr></table></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>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/proto/CloseCode.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/proto/CloseCode.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=enum.CloseCode.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="enum.CloseCode.html">enum.CloseCode.html</a>...</p>
|
||||
<script>location.replace("enum.CloseCode.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.CloseReason.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.CloseReason.html">struct.CloseReason.html</a>...</p>
|
||||
<script>location.replace("struct.CloseReason.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/proto/OpCode.t.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/proto/OpCode.t.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=enum.OpCode.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="enum.OpCode.html">enum.OpCode.html</a>...</p>
|
||||
<script>location.replace("enum.OpCode.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../actix_web/ws/enum.CloseCode.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../actix_web/ws/enum.CloseCode.html">../../../actix_web/ws/enum.CloseCode.html</a>...</p>
|
||||
<script>location.replace("../../../actix_web/ws/enum.CloseCode.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
static/api/actix-web/0.7.0/stable/ws/proto/enum.OpCode.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/proto/enum.OpCode.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../actix_web/ws/enum.OpCode.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../actix_web/ws/enum.OpCode.html">../../../actix_web/ws/enum.OpCode.html</a>...</p>
|
||||
<script>location.replace("../../../actix_web/ws/enum.OpCode.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../actix_web/ws/struct.CloseReason.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../actix_web/ws/struct.CloseReason.html">../../../actix_web/ws/struct.CloseReason.html</a>...</p>
|
||||
<script>location.replace("../../../actix_web/ws/struct.CloseReason.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
1
static/api/actix-web/0.7.0/stable/ws/sidebar-items.js
Normal file
1
static/api/actix-web/0.7.0/stable/ws/sidebar-items.js
Normal file
@ -0,0 +1 @@
|
||||
initSidebarItems({"enum":[["ClientError","Websocket client error"],["CloseCode","Status code used to indicate why an endpoint is closing the `WebSocket` connection."],["HandshakeError","Websocket handshake errors"],["Message","`WebSocket` Message"],["OpCode","Operation codes as part of rfc6455."],["ProtocolError","Websocket protocol errors"]],"fn":[["handshake","Prepare `WebSocket` handshake response."],["start","Do websocket handshake and start actor"]],"struct":[["Client","`WebSocket` client"],["ClientHandshake","Future that implementes client websocket handshake process."],["ClientReader","Websocket reader client"],["ClientWriter","Websocket writer client"],["CloseReason","Reason for closing the connection"],["Frame","A struct representing a `WebSocket` frame."],["FramedMessage","`WebSocket` message with framing."],["WebsocketContext","Execution context for `WebSockets` actors"],["WsStream","Maps `Payload` stream into stream of `ws::Message` items"]],"trait":[["WsWriter","Common writing methods for a websocket."]]});
|
||||
10
static/api/actix-web/0.7.0/stable/ws/start.v.html
Normal file
10
static/api/actix-web/0.7.0/stable/ws/start.v.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=fn.start.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="fn.start.html">fn.start.html</a>...</p>
|
||||
<script>location.replace("fn.start.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
28
static/api/actix-web/0.7.0/stable/ws/struct.Client.html
Normal file
28
static/api/actix-web/0.7.0/stable/ws/struct.Client.html
Normal file
@ -0,0 +1,28 @@
|
||||
<!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 `Client` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, Client"><title>actix_web::ws::Client - 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 struct"><!--[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'>Struct Client</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.with_connector">with_connector</a><a href="#method.protocols">protocols</a><a href="#method.cookie">cookie</a><a href="#method.origin">origin</a><a href="#method.max_frame_size">max_frame_size</a><a href="#method.write_buffer_capacity">write_buffer_capacity</a><a href="#method.no_masking">no_masking</a><a href="#method.header">header</a><a href="#method.timeout">timeout</a><a href="#method.connect">connect</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'Client', ty: 'struct', 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'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="struct" href=''>Client</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><a class='srclink' href='../../src/actix_web/ws/client.rs.html#122-131' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Client { /* fields omitted */ }</pre></div><div class='docblock'><p><code>WebSocket</code> client</p>
|
||||
<p>Example of <code>WebSocket</code> client usage is available in
|
||||
<a href="https://github.com/actix/examples/blob/master/websocket/src/client.rs#L24">websocket example</a></p>
|
||||
</div>
|
||||
<h2 id='methods' class='small-section-header'>
|
||||
Methods<a href='#methods' class='anchor'></a>
|
||||
</h2>
|
||||
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../actix_web/ws/struct.Client.html" title="struct actix_web::ws::Client">Client</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#133-274' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>(uri: S) -> <a class="struct" href="../../actix_web/ws/struct.Client.html" title="struct actix_web::ws::Client">Client</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#135-137' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create new websocket connection</p>
|
||||
</div><h4 id='method.with_connector' class="method"><span id='with_connector.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_connector' class='fnname'>with_connector</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>(<br> uri: S, <br> conn: <a class="struct" href="../../actix_web/actix/actix/struct.Addr.html" title="struct actix_web::actix::actix::Addr">Addr</a><<a class="struct" href="../../actix_web/client/struct.ClientConnector.html" title="struct actix_web::client::ClientConnector">ClientConnector</a>><br>) -> <a class="struct" href="../../actix_web/ws/struct.Client.html" title="struct actix_web::ws::Client">Client</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#140-153' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create new websocket connection with custom <code>ClientConnector</code></p>
|
||||
</div><h4 id='method.protocols' class="method"><span id='protocols.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.protocols' class='fnname'>protocols</a><U, V>(self, protos: U) -> Self <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a><Item = V> + 'static,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#156-167' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set supported websocket protocols</p>
|
||||
</div><h4 id='method.cookie' class="method"><span id='cookie.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.cookie' class='fnname'>cookie</a>(self, cookie: <a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#170-173' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set cookie for handshake request</p>
|
||||
</div><h4 id='method.origin' class="method"><span id='origin.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.origin' class='fnname'>origin</a><V>(self, origin: V) -> Self <span class="where fmt-newline">where<br> <a class="struct" href="../../actix_web/http/header/struct.HeaderValue.html" title="struct actix_web::http::header::HeaderValue">HeaderValue</a>: <a class="trait" href="https://docs.rs/http/0.1.7/http/convert/trait.HttpTryFrom.html" title="trait http::convert::HttpTryFrom">HttpTryFrom</a><V>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#176-185' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set request Origin</p>
|
||||
</div><h4 id='method.max_frame_size' class="method"><span id='max_frame_size.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.max_frame_size' class='fnname'>max_frame_size</a>(self, size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#190-193' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set max frame size</p>
|
||||
<p>By default max size is set to 64kb</p>
|
||||
</div><h4 id='method.write_buffer_capacity' class="method"><span id='write_buffer_capacity.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.write_buffer_capacity' class='fnname'>write_buffer_capacity</a>(self, cap: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#198-201' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set write buffer capacity</p>
|
||||
<p>Default buffer capacity is 32kb</p>
|
||||
</div><h4 id='method.no_masking' class="method"><span id='no_masking.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.no_masking' class='fnname'>no_masking</a>(self) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#204-207' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Disable payload masking. By default ws client masks frame payload.</p>
|
||||
</div><h4 id='method.header' class="method"><span id='header.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.header' class='fnname'>header</a><K, V>(self, key: K, value: V) -> Self <span class="where fmt-newline">where<br> <a class="struct" href="../../actix_web/http/header/struct.HeaderName.html" title="struct actix_web::http::header::HeaderName">HeaderName</a>: <a class="trait" href="https://docs.rs/http/0.1.7/http/convert/trait.HttpTryFrom.html" title="trait http::convert::HttpTryFrom">HttpTryFrom</a><K>,<br> V: IntoHeaderValue, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#210-217' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set request header</p>
|
||||
</div><h4 id='method.timeout' class="method"><span id='timeout.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.timeout' class='fnname'>timeout</a>(self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#223-226' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set websocket handshake timeout</p>
|
||||
<p>Handshake timeout is a total time for successful handshake.
|
||||
Default value is 5 seconds.</p>
|
||||
</div><h4 id='method.connect' class="method"><span id='connect.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.connect' class='fnname'>connect</a>(&mut self) -> <a class="struct" href="../../actix_web/ws/struct.ClientHandshake.html" title="struct actix_web::ws::ClientHandshake">ClientHandshake</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#229-273' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Connect to websocket server and do ws handshake</p>
|
||||
</div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../actix_web/ws/struct.Client.html" title="struct actix_web::ws::Client">Client</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../actix_web/ws/struct.Client.html" title="struct actix_web::ws::Client">Client</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
@ -0,0 +1,49 @@
|
||||
<!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 `ClientHandshake` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, ClientHandshake"><title>actix_web::ws::ClientHandshake - 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 struct"><!--[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'>Struct ClientHandshake</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.timeout">timeout</a><a href="#method.conn_timeout">conn_timeout</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Future">Future</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'ClientHandshake', ty: 'struct', 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'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="struct" href=''>ClientHandshake</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><a class='srclink' href='../../src/actix_web/ws/client.rs.html#286-293' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct ClientHandshake { /* fields omitted */ }</pre></div><div class='docblock'><p>Future that implementes client websocket handshake process.</p>
|
||||
<p>It resolves to a pair of <code>ClientReader</code> and <code>ClientWriter</code> that
|
||||
can be used for reading and writing websocket frames.</p>
|
||||
</div>
|
||||
<h2 id='methods' class='small-section-header'>
|
||||
Methods<a href='#methods' class='anchor'></a>
|
||||
</h2>
|
||||
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../actix_web/ws/struct.ClientHandshake.html" title="struct actix_web::ws::ClientHandshake">ClientHandshake</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#295-358' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.timeout' class="method"><span id='timeout.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.timeout' class='fnname'>timeout</a>(self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#340-345' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set handshake timeout</p>
|
||||
<p>Handshake timeout is a total time before handshake should be completed.
|
||||
Default value is 5 seconds.</p>
|
||||
</div><h4 id='method.conn_timeout' class="method"><span id='conn_timeout.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.conn_timeout' class='fnname'>conn_timeout</a>(self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#352-357' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set connection timeout</p>
|
||||
<p>Connection timeout includes resolving hostname and actual connection to
|
||||
the host.
|
||||
Default value is 1 second.</p>
|
||||
</div></div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-Future' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../actix_web/ws/struct.ClientHandshake.html" title="struct actix_web::ws::ClientHandshake">ClientHandshake</a></code><a href='#impl-Future' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#360-448' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../../actix_web/ws/struct.ClientReader.html" title="struct actix_web::ws::ClientReader">ClientReader</a>, <a class="struct" href="../../actix_web/ws/struct.ClientWriter.html" title="struct actix_web::ws::ClientWriter">ClientWriter</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span></h4>
|
||||
<div class='docblock'><p>The type of value that this future will resolved with if it is successful. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Item">Read more</a></p>
|
||||
</div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a></code></span></h4>
|
||||
<div class='docblock'><p>The type of error that this future will resolve with if it fails in a normal fashion. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error">Read more</a></p>
|
||||
</div><h4 id='method.poll' class="method"><span id='poll.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#tymethod.poll' class='fnname'>poll</a>(&mut self) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>, Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#364-447' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Query this future to see if its value has become available, registering interest if it is not. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#tymethod.poll">Read more</a></p>
|
||||
</div><h4 id='method.wait' class="method"><span id='wait.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.wait' class='fnname'>wait</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>, Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#296-300' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Block the current thread until this future is resolved. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.wait">Read more</a></p>
|
||||
</div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.map' class='fnname'>map</a><F, U>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/map/struct.Map.html" title="struct futures::future::map::Map">Map</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>) -> U, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#370-375' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Map this future's result to a different type, returning a new future of the resulting type. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.map">Read more</a></p>
|
||||
</div><h4 id='method.map_err' class="method"><span id='map_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.map_err' class='fnname'>map_err</a><F, E>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/map_err/struct.MapErr.html" title="struct futures::future::map_err::MapErr">MapErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>) -> E, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#410-415' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Map this future's error to a different error, returning a new future. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.map_err">Read more</a></p>
|
||||
</div><h4 id='method.from_err' class="method"><span id='from_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.from_err' class='fnname'>from_err</a><E>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/from_err/struct.FromErr.html" title="struct futures::future::from_err::FromErr">FromErr</a><Self, E> <span class="where fmt-newline">where<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#440-444' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Map this future's error to any error implementing <code>From</code> for this future's <code>Error</code>, returning a new future. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.from_err">Read more</a></p>
|
||||
</div><h4 id='method.then' class="method"><span id='then.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.then' class='fnname'>then</a><F, B>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/then/struct.Then.html" title="struct futures::future::then::Then">Then</a><Self, B, F> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>, Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>) -> B, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#484-490' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Chain on a computation for when a future finished, passing the result of the future to the provided closure <code>f</code>. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.then">Read more</a></p>
|
||||
</div><h4 id='method.and_then' class="method"><span id='and_then.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.and_then' class='fnname'>and_then</a><F, B>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/and_then/struct.AndThen.html" title="struct futures::future::and_then::AndThen">AndThen</a><Self, B, F> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>) -> B, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#525-531' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Execute another future after this one has resolved successfully. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.and_then">Read more</a></p>
|
||||
</div><h4 id='method.or_else' class="method"><span id='or_else.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.or_else' class='fnname'>or_else</a><F, B>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/or_else/struct.OrElse.html" title="struct futures::future::or_else::OrElse">OrElse</a><Self, B, F> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>) -> B, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#566-572' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Execute another future if this one resolves with an error. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.or_else">Read more</a></p>
|
||||
</div><h4 id='method.select' class="method"><span id='select.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.select' class='fnname'>select</a><B>(self, other: B) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/select/struct.Select.html" title="struct futures::future::select::Select">Select</a><Self, <B as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>, Error = Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#624-631' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Waits for either one of two futures to complete. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.select">Read more</a></p>
|
||||
</div><h4 id='method.select2' class="method"><span id='select2.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.select2' class='fnname'>select2</a><B>(self, other: B) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/select2/struct.Select2.html" title="struct futures::future::select2::Select2">Select2</a><Self, <B as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#670-674' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Waits for either one of two differently-typed futures to complete. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.select2">Read more</a></p>
|
||||
</div><h4 id='method.join' class="method"><span id='join.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.join' class='fnname'>join</a><B>(self, other: B) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/join/struct.Join.html" title="struct futures::future::join::Join">Join</a><Self, <B as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#715-721' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Joins the result of two futures, waiting for them both to complete. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.join">Read more</a></p>
|
||||
</div><h4 id='method.join3' class="method"><span id='join3.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.join3' class='fnname'>join3</a><B, C>(<br> self, <br> b: B, <br> c: C<br>) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/join/struct.Join3.html" title="struct futures::future::join::Join3">Join3</a><Self, <B as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, <C as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>,<br> C: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#724-730' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Same as <code>join</code>, but with more futures.</p>
|
||||
</div><h4 id='method.join4' class="method"><span id='join4.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.join4' class='fnname'>join4</a><B, C, D>(<br> self, <br> b: B, <br> c: C, <br> d: D<br>) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/join/struct.Join4.html" title="struct futures::future::join::Join4">Join4</a><Self, <B as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, <C as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, <D as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>,<br> C: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>,<br> D: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#733-741' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Same as <code>join</code>, but with more futures.</p>
|
||||
</div><h4 id='method.join5' class="method"><span id='join5.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.join5' class='fnname'>join5</a><B, C, D, E>(<br> self, <br> b: B, <br> c: C, <br> d: D, <br> e: E<br>) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/join/struct.Join5.html" title="struct futures::future::join::Join5">Join5</a><Self, <B as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, <C as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, <D as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, <E as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>,<br> C: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>,<br> D: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>,<br> E: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#744-754' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Same as <code>join</code>, but with more futures.</p>
|
||||
</div><h4 id='method.into_stream' class="method"><span id='into_stream.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.into_stream' class='fnname'>into_stream</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/into_stream/struct.IntoStream.html" title="struct futures::future::into_stream::IntoStream">IntoStream</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#777-781' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Convert this future into a single element stream. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.into_stream">Read more</a></p>
|
||||
</div><h4 id='method.flatten' class="method"><span id='flatten.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.flatten' class='fnname'>flatten</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/flatten/struct.Flatten.html" title="struct futures::future::flatten::Flatten">Flatten</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>,<br> <Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a> as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Error" title="type futures::future::IntoFuture::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#819-829' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Flatten the execution of this future when the successful result of this future is itself another future. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.flatten">Read more</a></p>
|
||||
</div><h4 id='method.flatten_stream' class="method"><span id='flatten_stream.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.flatten_stream' class='fnname'>flatten_stream</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/flatten_stream/struct.FlattenStream.html" title="struct futures::future::flatten_stream::FlattenStream">FlattenStream</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>,<br> <Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a> 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> == Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#859-864' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Flatten the execution of this future when the successful result of this future is a stream. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.flatten_stream">Read more</a></p>
|
||||
</div><h4 id='method.fuse' class="method"><span id='fuse.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.fuse' class='fnname'>fuse</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/fuse/struct.Fuse.html" title="struct futures::future::fuse::Fuse">Fuse</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#899-904' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Fuse a future such that <code>poll</code> will never again be called once it has completed. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.fuse">Read more</a></p>
|
||||
</div><h4 id='method.inspect' class="method"><span id='inspect.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.inspect' class='fnname'>inspect</a><F>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/inspect/struct.Inspect.html" title="struct futures::future::inspect::Inspect">Inspect</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>), </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#922-927' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Do something with the item of a future, passing it on. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.inspect">Read more</a></p>
|
||||
</div><h4 id='method.catch_unwind' class="method"><span id='catch_unwind.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.catch_unwind' class='fnname'>catch_unwind</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/catch_unwind/struct.CatchUnwind.html" title="struct futures::future::catch_unwind::CatchUnwind">CatchUnwind</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#961-965' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Catches unwinding panics while polling the future. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.catch_unwind">Read more</a></p>
|
||||
</div><h4 id='method.shared' class="method"><span id='shared.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.shared' class='fnname'>shared</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/future/shared/struct.Shared.html" title="struct futures::future::shared::Shared">Shared</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/future/mod.rs.html#1010-1014' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a cloneable handle to this future where all handles will resolve to the same result. <a href="https://docs.rs/futures/0.1/futures/future/trait.Future.html#method.shared">Read more</a></p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../actix_web/ws/struct.ClientHandshake.html" title="struct actix_web::ws::ClientHandshake">ClientHandshake</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../actix_web/ws/struct.ClientHandshake.html" title="struct actix_web::ws::ClientHandshake">ClientHandshake</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
@ -0,0 +1,54 @@
|
||||
<!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 `ClientReader` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, ClientReader"><title>actix_web::ws::ClientReader - 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 struct"><!--[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'>Struct ClientReader</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Stream">Stream</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'ClientReader', ty: 'struct', 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'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="struct" href=''>ClientReader</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><a class='srclink' href='../../src/actix_web/ws/client.rs.html#451-455' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct ClientReader { /* fields omitted */ }</pre></div><div class='docblock'><p>Websocket reader client</p>
|
||||
</div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../actix_web/ws/struct.ClientReader.html" title="struct actix_web::ws::ClientReader">ClientReader</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#457-461' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#458-460' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id='impl-Stream' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a> for <a class="struct" href="../../actix_web/ws/struct.ClientReader.html" title="struct actix_web::ws::ClientReader">ClientReader</a></code><a href='#impl-Stream' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#463-522' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Item' class="type">Item</a> = <a class="enum" href="../../actix_web/ws/enum.Message.html" title="enum actix_web::ws::Message">Message</a></code></span></h4>
|
||||
<div class='docblock'><p>The type of item this stream will yield on success.</p>
|
||||
</div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a></code></span></h4>
|
||||
<div class='docblock'><p>The type of error this stream may generate.</p>
|
||||
</div><h4 id='method.poll' class="method"><span id='poll.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#tymethod.poll' class='fnname'>poll</a>(&mut self) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<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>>, Self::<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>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#467-521' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempt to pull out the next value of this stream, returning <code>None</code> if the stream is finished. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#tymethod.poll">Read more</a></p>
|
||||
</div><h4 id='method.wait' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a><S></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a><S></h3><code class="content"><span class="where fmt-newline">impl<S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a><S> <span class="where fmt-newline">where<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><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</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>, <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></div></div><span id='wait.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.wait' class='fnname'>wait</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#244-248' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates an iterator which blocks the current thread until each item of this stream is resolved. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.wait">Read more</a></p>
|
||||
</div><h4 id='method.into_future' class="method"><span id='into_future.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.into_future' class='fnname'>into_future</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/future/struct.StreamFuture.html" title="struct futures::stream::future::StreamFuture">StreamFuture</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#291-295' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Converts this stream into a <code>Future</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.into_future">Read more</a></p>
|
||||
</div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.map' class='fnname'>map</a><U, F>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/map/struct.Map.html" title="struct futures::stream::map::Map">Map</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<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>) -> U, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#316-321' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Converts a stream of type <code>T</code> to a stream of type <code>U</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.map">Read more</a></p>
|
||||
</div><h4 id='method.map_err' class="method"><span id='map_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.map_err' class='fnname'>map_err</a><U, F>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/map_err/struct.MapErr.html" title="struct futures::stream::map_err::MapErr">MapErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<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>) -> U, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#342-347' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Converts a stream of error type <code>T</code> to a stream of error type <code>U</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.map_err">Read more</a></p>
|
||||
</div><h4 id='method.filter' class="method"><span id='filter.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.filter' class='fnname'>filter</a><F>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/filter/struct.Filter.html" title="struct futures::stream::filter::Filter">Filter</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<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>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#372-377' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Filters the values produced by this stream according to the provided predicate. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.filter">Read more</a></p>
|
||||
</div><h4 id='method.filter_map' class="method"><span id='filter_map.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.filter_map' class='fnname'>filter_map</a><F, B>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/filter_map/struct.FilterMap.html" title="struct futures::stream::filter_map::FilterMap">FilterMap</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<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>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><B>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#408-413' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Filters the values produced by this stream while simultaneously mapping them to a different type. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.filter_map">Read more</a></p>
|
||||
</div><h4 id='method.then' class="method"><span id='then.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.then' class='fnname'>then</a><F, U>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/then/struct.Then.html" title="struct futures::stream::then::Then">Then</a><Self, F, U> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<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>, Self::<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>>) -> U,<br> U: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#447-453' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Chain on a computation for when a value is ready, passing the resulting item to the provided closure <code>f</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.then">Read more</a></p>
|
||||
</div><h4 id='method.and_then' class="method"><span id='and_then.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.and_then' class='fnname'>and_then</a><F, U>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/and_then/struct.AndThen.html" title="struct futures::stream::and_then::AndThen">AndThen</a><Self, F, U> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<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>) -> U,<br> U: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#494-500' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Chain on a computation for when a value is ready, passing the successful results to the provided closure <code>f</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.and_then">Read more</a></p>
|
||||
</div><h4 id='method.or_else' class="method"><span id='or_else.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.or_else' class='fnname'>or_else</a><F, U>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/or_else/struct.OrElse.html" title="struct futures::stream::or_else::OrElse">OrElse</a><Self, F, U> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<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>) -> U,<br> U: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = Self::<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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#521-527' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Chain on a computation for when an error happens, passing the erroneous result to the provided closure <code>f</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.or_else">Read more</a></p>
|
||||
</div><h4 id='method.collect' class="method"><span id='collect.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.collect' class='fnname'>collect</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/collect/struct.Collect.html" title="struct futures::stream::collect::Collect">Collect</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#562-566' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Collect all of the values of this stream into a vector, returning a future representing the result of that computation. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.collect">Read more</a></p>
|
||||
</div><h4 id='method.concat2' class="method"><span id='concat2.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.concat2' class='fnname'>concat2</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/concat/struct.Concat2.html" title="struct futures::stream::concat::Concat2">Concat2</a><Self> <span class="where fmt-newline">where<br> Self::<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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.Extend.html" title="trait core::iter::traits::Extend">Extend</a><<Self::<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> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::IntoIterator::Item">Item</a>>,<br> Self::<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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>,<br> Self::<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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#598-603' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.concat2">Read more</a></p>
|
||||
</div><h4 id='method.concat' class="method"><span id='concat.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.concat' class='fnname'>concat</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/concat/struct.Concat.html" title="struct futures::stream::concat::Concat">Concat</a><Self> <span class="where fmt-newline">where<br> Self::<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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.Extend.html" title="trait core::iter::traits::Extend">Extend</a><<Self::<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> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::IntoIterator::Item">Item</a>>,<br> Self::<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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#638-643' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab deprecated'>Deprecated since 0.1.14<p>: please use <code>Stream::concat2</code> instead</p>
|
||||
</div></div><div class='docblock'><p>Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.concat">Read more</a></p>
|
||||
</div><h4 id='method.fold' class="method"><span id='fold.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.fold' class='fnname'>fold</a><F, T, Fut>(self, init: T, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/fold/struct.Fold.html" title="struct futures::stream::fold::Fold">Fold</a><Self, F, Fut, T> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(T, Self::<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>) -> Fut,<br> Fut: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = T>,<br> Self::<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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<Fut as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Error" title="type futures::future::IntoFuture::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#668-675' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Execute an accumulating computation over a stream, collecting all the values into one final result. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.fold">Read more</a></p>
|
||||
</div><h4 id='method.flatten' class="method"><span id='flatten.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.flatten' class='fnname'>flatten</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/flatten/struct.Flatten.html" title="struct futures::stream::flatten::Flatten">Flatten</a><Self> <span class="where fmt-newline">where<br> Self::<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>: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>,<br> <Self::<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> 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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#710-716' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Flattens a stream of streams into just one continuous stream. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.flatten">Read more</a></p>
|
||||
</div><h4 id='method.skip_while' class="method"><span id='skip_while.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.skip_while' class='fnname'>skip_while</a><P, R>(self, pred: P) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/skip_while/struct.SkipWhile.html" title="struct futures::stream::skip_while::SkipWhile">SkipWhile</a><Self, P, R> <span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<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>) -> R,<br> R: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#725-731' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Skip elements on this stream while the predicate provided resolves to <code>true</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.skip_while">Read more</a></p>
|
||||
</div><h4 id='method.take_while' class="method"><span id='take_while.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.take_while' class='fnname'>take_while</a><P, R>(self, pred: P) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/take_while/struct.TakeWhile.html" title="struct futures::stream::take_while::TakeWhile">TakeWhile</a><Self, P, R> <span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<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>) -> R,<br> R: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#739-745' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Take elements from this stream while the predicate provided resolves to <code>true</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.take_while">Read more</a></p>
|
||||
</div><h4 id='method.for_each' class="method"><span id='for_each.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.for_each' class='fnname'>for_each</a><F, U>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/for_each/struct.ForEach.html" title="struct futures::stream::for_each::ForEach">ForEach</a><Self, F, U> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<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>) -> U,<br> U: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#761-767' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Runs this stream to completion, executing the provided closure for each element on the stream. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.for_each">Read more</a></p>
|
||||
</div><h4 id='method.from_err' class="method"><span id='from_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.from_err' class='fnname'>from_err</a><E>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/from_err/struct.FromErr.html" title="struct futures::stream::from_err::FromErr">FromErr</a><Self, E> <span class="where fmt-newline">where<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#780-784' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Map this stream's error to any error implementing <code>From</code> for this stream's <code>Error</code>, returning a new stream. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.from_err">Read more</a></p>
|
||||
</div><h4 id='method.take' class="method"><span id='take.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.take' class='fnname'>take</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/take/struct.Take.html" title="struct futures::stream::take::Take">Take</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#796-800' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new stream of at most <code>amt</code> items of the underlying stream. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.take">Read more</a></p>
|
||||
</div><h4 id='method.skip' class="method"><span id='skip.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.skip' class='fnname'>skip</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/skip/struct.Skip.html" title="struct futures::stream::skip::Skip">Skip</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#811-815' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new stream which skips <code>amt</code> items of the underlying stream. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.skip">Read more</a></p>
|
||||
</div><h4 id='method.fuse' class="method"><span id='fuse.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.fuse' class='fnname'>fuse</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/fuse/struct.Fuse.html" title="struct futures::stream::fuse::Fuse">Fuse</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#832-836' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Fuse a stream such that <code>poll</code> will never again be called once it has finished. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.fuse">Read more</a></p>
|
||||
</div><h4 id='method.by_ref' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='by_ref.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.by_ref' class='fnname'>by_ref</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#857-861' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Borrows a stream, rather than consuming it. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.by_ref">Read more</a></p>
|
||||
</div><h4 id='method.catch_unwind' class="method"><span id='catch_unwind.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.catch_unwind' class='fnname'>catch_unwind</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/catch_unwind/struct.CatchUnwind.html" title="struct futures::stream::catch_unwind::CatchUnwind">CatchUnwind</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#897-901' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Catches unwinding panics while polling the stream. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.catch_unwind">Read more</a></p>
|
||||
</div><h4 id='method.buffered' class="method"><span id='buffered.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.buffered' class='fnname'>buffered</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/buffered/struct.Buffered.html" title="struct futures::stream::buffered::Buffered">Buffered</a><Self> <span class="where fmt-newline">where<br> Self::<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>: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>,<br> <Self::<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> as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Error" title="type futures::future::IntoFuture::Error">Error</a> == Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#917-922' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>An adaptor for creating a buffered list of pending futures. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.buffered">Read more</a></p>
|
||||
</div><h4 id='method.buffer_unordered' class="method"><span id='buffer_unordered.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.buffer_unordered' class='fnname'>buffer_unordered</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/buffer_unordered/struct.BufferUnordered.html" title="struct futures::stream::buffer_unordered::BufferUnordered">BufferUnordered</a><Self> <span class="where fmt-newline">where<br> Self::<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>: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>,<br> <Self::<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> as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Error" title="type futures::future::IntoFuture::Error">Error</a> == Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#938-943' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>An adaptor for creating a buffered list of pending futures (unordered). <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.buffer_unordered">Read more</a></p>
|
||||
</div><h4 id='method.merge' class="method"><span id='merge.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.merge' class='fnname'>merge</a><S>(self, other: S) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/merge/struct.Merge.html" title="struct futures::stream::merge::Merge">Merge</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#952-957' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab deprecated'>Deprecated<p>: functionality provided by <code>select</code> now</p>
|
||||
</div></div><div class='docblock'><p>An adapter for merging the output of two streams. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.merge">Read more</a></p>
|
||||
</div><h4 id='method.zip' class="method"><span id='zip.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.zip' class='fnname'>zip</a><S>(self, other: S) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/zip/struct.Zip.html" title="struct futures::stream::zip::Zip">Zip</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#964-969' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>An adapter for zipping two streams together. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.zip">Read more</a></p>
|
||||
</div><h4 id='method.chain' class="method"><span id='chain.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.chain' class='fnname'>chain</a><S>(self, other: S) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/chain/struct.Chain.html" title="struct futures::stream::chain::Chain">Chain</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = Self::<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>, Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#990-995' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Adapter for chaining two stream. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.chain">Read more</a></p>
|
||||
</div><h4 id='method.peekable' class="method"><span id='peekable.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.peekable' class='fnname'>peekable</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/peek/struct.Peekable.html" title="struct futures::stream::peek::Peekable">Peekable</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#1000-1004' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new stream which exposes a <code>peek</code> method. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.peekable">Read more</a></p>
|
||||
</div><h4 id='method.chunks' class="method"><span id='chunks.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.chunks' class='fnname'>chunks</a>(self, capacity: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/chunks/struct.Chunks.html" title="struct futures::stream::chunks::Chunks">Chunks</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#1027-1031' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>An adaptor for chunking up items of the stream inside a vector. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.chunks">Read more</a></p>
|
||||
</div><h4 id='method.select' class="method"><span id='select.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.select' class='fnname'>select</a><S>(self, other: S) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/select/struct.Select.html" title="struct futures::stream::select::Select">Select</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = Self::<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>, Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#1044-1049' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.select">Read more</a></p>
|
||||
</div><h4 id='method.forward' class="method"><span id='forward.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.forward' class='fnname'>forward</a><S>(self, sink: S) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/forward/struct.Forward.html" title="struct futures::stream::forward::Forward">Forward</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a><SinkItem = Self::<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>>,<br> Self::<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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<S as <a class="trait" href="https://docs.rs/futures/0.1/futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/sink/trait.Sink.html#associatedtype.SinkError" title="type futures::sink::Sink::SinkError">SinkError</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#1065-1071' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>A future that completes after the given stream has been fully processed into the sink, including flushing. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.forward">Read more</a></p>
|
||||
</div><h4 id='method.split' class="method"><span id='split.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.split' class='fnname'>split</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="https://docs.rs/futures/0.1/futures/stream/split/struct.SplitSink.html" title="struct futures::stream::split::SplitSink">SplitSink</a><Self>, <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/split/struct.SplitStream.html" title="struct futures::stream::split::SplitStream">SplitStream</a><Self><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://docs.rs/futures/0.1/futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#1083-1087' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Splits this <code>Stream + Sink</code> object into separate <code>Stream</code> and <code>Sink</code> objects. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.split">Read more</a></p>
|
||||
</div><h4 id='method.inspect' class="method"><span id='inspect.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.inspect' class='fnname'>inspect</a><F>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/inspect/struct.Inspect.html" title="struct futures::stream::inspect::Inspect">Inspect</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#1094-1099' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Do something with each item of this stream, afterwards passing it on. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.inspect">Read more</a></p>
|
||||
</div><h4 id='method.inspect_err' class="method"><span id='inspect_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.inspect_err' class='fnname'>inspect_err</a><F>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/inspect_err/struct.InspectErr.html" title="struct futures::stream::inspect_err::InspectErr">InspectErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#1106-1111' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Do something with the error of this stream, afterwards passing it on. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.inspect_err">Read more</a></p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../actix_web/ws/struct.ClientReader.html" title="struct actix_web::ws::ClientReader">ClientReader</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../actix_web/ws/struct.ClientReader.html" title="struct actix_web::ws::ClientReader">ClientReader</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
@ -0,0 +1,25 @@
|
||||
<!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 `ClientWriter` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, ClientWriter"><title>actix_web::ws::ClientWriter - 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 struct"><!--[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'>Struct ClientWriter</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.text">text</a><a href="#method.binary">binary</a><a href="#method.ping">ping</a><a href="#method.pong">pong</a><a href="#method.close">close</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-WsWriter">WsWriter</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'ClientWriter', ty: 'struct', 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'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="struct" href=''>ClientWriter</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><a class='srclink' href='../../src/actix_web/ws/client.rs.html#525-527' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct ClientWriter { /* fields omitted */ }</pre></div><div class='docblock'><p>Websocket writer client</p>
|
||||
</div>
|
||||
<h2 id='methods' class='small-section-header'>
|
||||
Methods<a href='#methods' class='anchor'></a>
|
||||
</h2>
|
||||
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../actix_web/ws/struct.ClientWriter.html" title="struct actix_web::ws::ClientWriter">ClientWriter</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#529-570' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.text' class="method"><span id='text.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.text' class='fnname'>text</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, text: T)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#543-545' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send text frame</p>
|
||||
</div><h4 id='method.binary' class="method"><span id='binary.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.binary' class='fnname'>binary</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, data: B)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#549-551' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send binary frame</p>
|
||||
</div><h4 id='method.ping' class="method"><span id='ping.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.ping' class='fnname'>ping</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#555-557' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send ping frame</p>
|
||||
</div><h4 id='method.pong' class="method"><span id='pong.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.pong' class='fnname'>pong</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#561-563' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send pong frame</p>
|
||||
</div><h4 id='method.close' class="method"><span id='close.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.close' class='fnname'>close</a>(&mut self, reason: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a>>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#567-569' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send close frame</p>
|
||||
</div></div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-WsWriter' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../actix_web/ws/trait.WsWriter.html" title="trait actix_web::ws::WsWriter">WsWriter</a> for <a class="struct" href="../../actix_web/ws/struct.ClientWriter.html" title="struct actix_web::ws::ClientWriter">ClientWriter</a></code><a href='#impl-WsWriter' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#572-602' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.send_text' class="method"><span id='send_text.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_text' class='fnname'>send_text</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, text: T)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#575-577' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send text frame</p>
|
||||
</div><h4 id='method.send_binary' class="method"><span id='send_binary.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_binary' class='fnname'>send_binary</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, data: B)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#581-583' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send binary frame</p>
|
||||
</div><h4 id='method.send_ping' class="method"><span id='send_ping.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_ping' class='fnname'>send_ping</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#587-589' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send ping frame</p>
|
||||
</div><h4 id='method.send_pong' class="method"><span id='send_pong.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_pong' class='fnname'>send_pong</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#593-595' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send pong frame</p>
|
||||
</div><h4 id='method.send_close' class="method"><span id='send_close.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_close' class='fnname'>send_close</a>(&mut self, reason: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a>>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/client.rs.html#599-601' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send close frame</p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../actix_web/ws/struct.ClientWriter.html" title="struct actix_web::ws::ClientWriter">ClientWriter</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../actix_web/ws/struct.ClientWriter.html" title="struct actix_web::ws::ClientWriter">ClientWriter</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
32
static/api/actix-web/0.7.0/stable/ws/struct.CloseReason.html
Normal file
32
static/api/actix-web/0.7.0/stable/ws/struct.CloseReason.html
Normal file
@ -0,0 +1,32 @@
|
||||
<!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 `CloseReason` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, CloseReason"><title>actix_web::ws::CloseReason - 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 struct"><!--[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'>Struct CloseReason</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.code">code</a><a href="#structfield.description">description</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Eq">Eq</a><a href="#impl-PartialEq">PartialEq</a><a href="#impl-Clone">Clone</a><a href="#impl-From%3CCloseCode%3E">From<CloseCode></a><a href="#impl-From%3C(CloseCode%2C%20T)%3E">From<(CloseCode, T)></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'CloseReason', ty: 'struct', 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'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="struct" href=''>CloseReason</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><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#184-189' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct CloseReason {
|
||||
pub code: <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a>,
|
||||
pub description: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>,
|
||||
}</pre></div><div class='docblock'><p>Reason for closing the connection</p>
|
||||
</div><h2 id='fields' class='fields small-section-header'>
|
||||
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.code" class="structfield small-section-header">
|
||||
<a href="#structfield.code" class="anchor field"></a>
|
||||
<span id="code.v" class='invisible'>
|
||||
<code>code: <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a></code>
|
||||
</span></span><div class='docblock'><p>Exit code</p>
|
||||
</div><span id="structfield.description" class="structfield small-section-header">
|
||||
<a href="#structfield.description" class="anchor field"></a>
|
||||
<span id="description.v" class='invisible'>
|
||||
<code>description: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code>
|
||||
</span></span><div class='docblock'><p>Optional description of the exit code</p>
|
||||
</div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#182' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#182' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id='impl-Eq' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a></code><a href='#impl-Eq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#182' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-PartialEq' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a></code><a href='#impl-PartialEq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#182' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, other: &<a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#182' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||||
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, other: &<a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#182' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
||||
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#182' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#182' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||||
</div></div><h3 id='impl-From%3CCloseCode%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a>> for <a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a></code><a href='#impl-From%3CCloseCode%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#191-198' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(code: <a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#192-197' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id='impl-From%3C(CloseCode%2C%20T)%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a>, T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> for <a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a></code><a href='#impl-From%3C(CloseCode%2C%20T)%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#200-207' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(info: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="enum" href="../../actix_web/ws/enum.CloseCode.html" title="enum actix_web::ws::CloseCode">CloseCode</a>, T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/proto.rs.html#201-206' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
23
static/api/actix-web/0.7.0/stable/ws/struct.Frame.html
Normal file
23
static/api/actix-web/0.7.0/stable/ws/struct.Frame.html
Normal file
@ -0,0 +1,23 @@
|
||||
<!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 `Frame` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, Frame"><title>actix_web::ws::Frame - 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 struct"><!--[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'>Struct Frame</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.unpack">unpack</a><a href="#method.close">close</a><a href="#method.parse">parse</a><a href="#method.parse_close_payload">parse_close_payload</a><a href="#method.message">message</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a><a href="#impl-Display">Display</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'Frame', ty: 'struct', 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'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="struct" href=''>Frame</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><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#17-21' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Frame { /* fields omitted */ }</pre></div><div class='docblock'><p>A struct representing a <code>WebSocket</code> frame.</p>
|
||||
</div>
|
||||
<h2 id='methods' class='small-section-header'>
|
||||
Methods<a href='#methods' class='anchor'></a>
|
||||
</h2>
|
||||
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../actix_web/ws/struct.Frame.html" title="struct actix_web::ws::Frame">Frame</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#23-342' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.unpack' class="method"><span id='unpack.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.unpack' class='fnname'>unpack</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a>, <a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#25-27' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Destruct frame</p>
|
||||
</div><h4 id='method.close' class="method"><span id='close.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.close' class='fnname'>close</a>(reason: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a>>, genmask: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../../actix_web/ws/struct.FramedMessage.html" title="struct actix_web::ws::FramedMessage">FramedMessage</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#31-47' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new Close control frame.</p>
|
||||
</div><h4 id='method.parse' class="method"><span id='parse.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.parse' class='fnname'>parse</a><S>(<br> pl: &mut <a class="struct" href="../../actix_web/dev/struct.PayloadBuffer.html" title="struct actix_web::dev::PayloadBuffer">PayloadBuffer</a><S>, <br> server: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> max_size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_web/ws/struct.Frame.html" title="struct actix_web::ws::Frame">Frame</a>>, <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a>> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = <a class="struct" href="https://docs.rs/bytes/0.4.8/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>, Error = <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#203-277' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Parse the input stream into a frame.</p>
|
||||
</div><h4 id='method.parse_close_payload' class="method"><span id='parse_close_payload.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.parse_close_payload' class='fnname'>parse_close_payload</a>(payload: &<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#280-293' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Parse the payload of a close frame.</p>
|
||||
</div><h4 id='method.message' class="method"><span id='message.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.message' class='fnname'>message</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(<br> data: B, <br> code: <a class="enum" href="../../actix_web/ws/enum.OpCode.html" title="enum actix_web::ws::OpCode">OpCode</a>, <br> finished: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> genmask: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -> <a class="struct" href="../../actix_web/ws/struct.FramedMessage.html" title="struct actix_web::ws::FramedMessage">FramedMessage</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#296-341' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Generate binary representation</p>
|
||||
</div></div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../actix_web/ws/struct.Frame.html" title="struct actix_web::ws::Frame">Frame</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#16' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#16' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id='impl-Default' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../../actix_web/ws/struct.Frame.html" title="struct actix_web::ws::Frame">Frame</a></code><a href='#impl-Default' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#344-352' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../../actix_web/ws/struct.Frame.html" title="struct actix_web::ws::Frame">Frame</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#345-351' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||||
</div></div><h3 id='impl-Display' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../../actix_web/ws/struct.Frame.html" title="struct actix_web::ws::Frame">Frame</a></code><a href='#impl-Display' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#354-375' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#355-374' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../actix_web/ws/struct.Frame.html" title="struct actix_web::ws::Frame">Frame</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../actix_web/ws/struct.Frame.html" title="struct actix_web::ws::Frame">Frame</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
@ -0,0 +1,12 @@
|
||||
<!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 `FramedMessage` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, FramedMessage"><title>actix_web::ws::FramedMessage - 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 struct"><!--[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'>Struct FramedMessage</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'FramedMessage', ty: 'struct', 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'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="struct" href=''>FramedMessage</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><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#379' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct FramedMessage(_);</pre></div><div class='docblock'><p><code>WebSocket</code> message with framing.</p>
|
||||
</div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../actix_web/ws/struct.FramedMessage.html" title="struct actix_web::ws::FramedMessage">FramedMessage</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#378' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/frame.rs.html#378' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../actix_web/ws/struct.FramedMessage.html" title="struct actix_web::ws::FramedMessage">FramedMessage</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../actix_web/ws/struct.FramedMessage.html" title="struct actix_web::ws::FramedMessage">FramedMessage</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
@ -0,0 +1,53 @@
|
||||
<!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 `WebsocketContext` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, WebsocketContext"><title>actix_web::ws::WebsocketContext - 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 struct"><!--[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'>Struct WebsocketContext</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.create">create</a><a href="#method.with_factory">with_factory</a><a href="#method.write_raw">write_raw</a><a href="#method.state">state</a><a href="#method.request">request</a><a href="#method.drain">drain</a><a href="#method.text">text</a><a href="#method.binary">binary</a><a href="#method.ping">ping</a><a href="#method.pong">pong</a><a href="#method.close">close</a><a href="#method.connected">connected</a><a href="#method.handle">handle</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-ActorContext">ActorContext</a><a href="#impl-AsyncContext%3CA%3E">AsyncContext<A></a><a href="#impl-WsWriter">WsWriter</a><a href="#impl-AsyncContextParts%3CA%3E">AsyncContextParts<A></a><a href="#impl-ToEnvelope%3CA%2C%20M%3E">ToEnvelope<A, M></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'WebsocketContext', ty: 'struct', 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'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="struct" href=''>WebsocketContext</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><a class='srclink' href='../../src/actix_web/ws/context.rs.html#28-36' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct WebsocketContext<A, S = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</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><Context = <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S>>, </span> { /* fields omitted */ }</pre></div><div class='docblock'><p>Execution context for <code>WebSockets</code> actors</p>
|
||||
</div>
|
||||
<h2 id='methods' class='small-section-header'>
|
||||
Methods<a href='#methods' class='anchor'></a>
|
||||
</h2>
|
||||
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, S: 'static> <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, 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><Context = Self>, </span></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#89-128' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.create' class="method"><span id='create.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.create' class='fnname'>create</a><P>(req: <a class="struct" href="../../actix_web/struct.HttpRequest.html" title="struct actix_web::HttpRequest">HttpRequest</a><S>, actor: A, stream: <a class="struct" href="../../actix_web/ws/struct.WsStream.html" title="struct actix_web::ws::WsStream">WsStream</a><P>) -> <a class="enum" href="../../actix_web/enum.Body.html" title="enum actix_web::Body">Body</a> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.StreamHandler.html" title="trait actix_web::actix::actix::dev::StreamHandler">StreamHandler</a><<a class="enum" href="../../actix_web/ws/enum.Message.html" title="enum actix_web::ws::Message">Message</a>, <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a>>,<br> P: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = <a class="struct" href="https://docs.rs/bytes/0.4.8/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>, Error = <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#95-110' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new Websocket context from a request and an actor</p>
|
||||
</div><h4 id='method.with_factory' class="method"><span id='with_factory.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_factory' class='fnname'>with_factory</a><F>(req: <a class="struct" href="../../actix_web/struct.HttpRequest.html" title="struct actix_web::HttpRequest">HttpRequest</a><S>, f: F) -> <a class="enum" href="../../actix_web/enum.Body.html" title="enum actix_web::Body">Body</a> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self) -> A + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#113-127' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new Websocket context</p>
|
||||
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, S> <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, 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><Context = Self>, </span></code><a href='#impl-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#130-234' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.write_raw' class="method"><span id='write_raw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.write_raw' class='fnname'>write_raw</a>(&mut self, data: <a class="struct" href="../../actix_web/ws/struct.FramedMessage.html" title="struct actix_web::ws::FramedMessage">FramedMessage</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#141-151' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Write payload</p>
|
||||
<p>This is a low-level function that accepts framed messages that should
|
||||
be created using <code>Frame::message()</code>. If you want to send text or binary
|
||||
data you should prefer the <code>text()</code> or <code>binary()</code> convenience functions
|
||||
that handle the framing for you.</p>
|
||||
</div><h4 id='method.state' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='state.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.state' class='fnname'>state</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>S</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#155-157' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Shared application state</p>
|
||||
</div><h4 id='method.request' class="method"><span id='request.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.request' class='fnname'>request</a>(&mut self) -> &mut <a class="struct" href="../../actix_web/struct.HttpRequest.html" title="struct actix_web::HttpRequest">HttpRequest</a><S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#161-163' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Incoming request</p>
|
||||
</div><h4 id='method.drain' class="method"><span id='drain.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.drain' class='fnname'>drain</a>(&mut self) -> <a class="struct" href="../../actix_web/dev/struct.Drain.html" title="struct actix_web::dev::Drain">Drain</a><A></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#166-170' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns drain future</p>
|
||||
</div><h4 id='method.text' class="method"><span id='text.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.text' class='fnname'>text</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, text: T)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#174-176' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send text frame</p>
|
||||
</div><h4 id='method.binary' class="method"><span id='binary.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.binary' class='fnname'>binary</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, data: B)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#180-182' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send binary frame</p>
|
||||
</div><h4 id='method.ping' class="method"><span id='ping.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.ping' class='fnname'>ping</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#186-193' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send ping frame</p>
|
||||
</div><h4 id='method.pong' class="method"><span id='pong.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.pong' class='fnname'>pong</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#197-204' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send pong frame</p>
|
||||
</div><h4 id='method.close' class="method"><span id='close.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.close' class='fnname'>close</a>(&mut self, reason: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a>>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#208-210' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send close frame</p>
|
||||
</div><h4 id='method.connected' class="method"><span id='connected.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.connected' class='fnname'>connected</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#214-216' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Check if connection still open</p>
|
||||
</div><h4 id='method.handle' class="method"><span id='handle.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.handle' class='fnname'>handle</a>(&self) -> <a class="struct" href="../../actix_web/actix/actix/dev/struct.SpawnHandle.html" title="struct actix_web::actix::actix::dev::SpawnHandle">SpawnHandle</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#231-233' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Handle of the running future</p>
|
||||
<p>SpawnHandle is the handle returned by <code>AsyncContext::spawn()</code> method.</p>
|
||||
</div></div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-ActorContext' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, S> <a class="trait" href="../../actix_web/actix/actix/dev/trait.ActorContext.html" title="trait actix_web::actix::actix::dev::ActorContext">ActorContext</a> for <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, 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><Context = Self>, </span></code><a href='#impl-ActorContext' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#38-51' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.stop' class="method"><span id='stop.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.ActorContext.html#tymethod.stop' class='fnname'>stop</a>(&mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#42-44' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Immediately stop processing incoming messages and switch to a <code>stopping</code> state <a href="../../actix_web/actix/actix/dev/trait.ActorContext.html#tymethod.stop">Read more</a></p>
|
||||
</div><h4 id='method.terminate' class="method"><span id='terminate.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.ActorContext.html#tymethod.terminate' class='fnname'>terminate</a>(&mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#45-47' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Terminate actor execution</p>
|
||||
</div><h4 id='method.state-1' class="method"><span id='state.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.ActorContext.html#tymethod.state' class='fnname'>state</a>(&self) -> <a class="enum" href="../../actix_web/actix/actix/enum.ActorState.html" title="enum actix_web::actix::actix::ActorState">ActorState</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#48-50' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Actor execution state</p>
|
||||
</div></div><h3 id='impl-AsyncContext%3CA%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, S> <a class="trait" href="../../actix_web/actix/actix/dev/trait.AsyncContext.html" title="trait actix_web::actix::actix::dev::AsyncContext">AsyncContext</a><A> for <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, 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><Context = Self>, </span></code><a href='#impl-AsyncContext%3CA%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#53-87' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.spawn' class="method"><span id='spawn.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.AsyncContext.html#tymethod.spawn' class='fnname'>spawn</a><F>(&mut self, fut: F) -> <a class="struct" href="../../actix_web/actix/actix/dev/struct.SpawnHandle.html" title="struct actix_web::actix::actix::dev::SpawnHandle">SpawnHandle</a> <span class="where fmt-newline">where<br> F: <a class="trait" href="../../actix_web/actix/actix/dev/trait.ActorFuture.html" title="trait actix_web::actix::actix::dev::ActorFuture">ActorFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Actor = A> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#57-62' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Spawn async future into context. Returns handle of the item, could be used for cancelling execution. <a href="../../actix_web/actix/actix/dev/trait.AsyncContext.html#tymethod.spawn">Read more</a></p>
|
||||
</div><h4 id='method.wait' class="method"><span id='wait.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.AsyncContext.html#tymethod.wait' class='fnname'>wait</a><F>(&mut self, fut: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="../../actix_web/actix/actix/dev/trait.ActorFuture.html" title="trait actix_web::actix::actix::dev::ActorFuture">ActorFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Actor = A> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#64-69' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Spawn future into the context. Stop processing any of incoming events until this future resolves. <a href="../../actix_web/actix/actix/dev/trait.AsyncContext.html#tymethod.wait">Read more</a></p>
|
||||
</div><h4 id='method.cancel_future' class="method"><span id='cancel_future.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.AsyncContext.html#tymethod.cancel_future' class='fnname'>cancel_future</a>(&mut self, handle: <a class="struct" href="../../actix_web/actix/actix/dev/struct.SpawnHandle.html" title="struct actix_web::actix::actix::dev::SpawnHandle">SpawnHandle</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#79-81' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Cancel future. handle is a value returned by <code>spawn</code> method.</p>
|
||||
</div><h4 id='method.address' class="method"><span id='address.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.AsyncContext.html#tymethod.address' class='fnname'>address</a>(&self) -> <a class="struct" href="../../actix_web/actix/actix/struct.Addr.html" title="struct actix_web::actix::actix::Addr">Addr</a><A></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#84-86' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return <code>Address</code> of the context</p>
|
||||
</div><h4 id='tymethod.waiting' class="tymethod"><span id='waiting.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.AsyncContext.html#tymethod.waiting' class='fnname'>waiting</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Check if context is paused (waiting for future completion or stopping)</p>
|
||||
</div><h4 id='method.add_stream' class="method"><span id='add_stream.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.AsyncContext.html#method.add_stream' class='fnname'>add_stream</a><S>(&mut self, fut: S) -> <a class="struct" href="../../actix_web/actix/actix/dev/struct.SpawnHandle.html" title="struct actix_web::actix::actix::dev::SpawnHandle">SpawnHandle</a> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.StreamHandler.html" title="trait actix_web::actix::actix::dev::StreamHandler">StreamHandler</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>, <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>>,<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a> + 'static, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>This method register stream to an actor context and allows to handle <code>Stream</code> in similar way as normal actor messages. <a href="../../actix_web/actix/actix/dev/trait.AsyncContext.html#method.add_stream">Read more</a></p>
|
||||
</div><h4 id='method.add_message_stream' class="method"><span id='add_message_stream.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.AsyncContext.html#method.add_message_stream' class='fnname'>add_message_stream</a><S>(&mut self, fut: S) <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Handler.html" title="trait actix_web::actix::actix::dev::Handler">Handler</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>>,<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Error = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> + 'static,<br> <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>: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Message.html" title="trait actix_web::actix::actix::dev::Message">Message</a>, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>This method is similar to <code>add_stream</code> but it skips stream errors. <a href="../../actix_web/actix/actix/dev/trait.AsyncContext.html#method.add_message_stream">Read more</a></p>
|
||||
</div><h4 id='method.notify' class="method"><span id='notify.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.AsyncContext.html#method.notify' class='fnname'>notify</a><M>(&mut self, msg: M) <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Handler.html" title="trait actix_web::actix::actix::dev::Handler">Handler</a><M>,<br> M: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Message.html" title="trait actix_web::actix::actix::dev::Message">Message</a> + 'static, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Send message <code>msg</code> to self.</p>
|
||||
</div><h4 id='method.notify_later' class="method"><span id='notify_later.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.AsyncContext.html#method.notify_later' class='fnname'>notify_later</a><M>(&mut self, msg: M, after: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -> <a class="struct" href="../../actix_web/actix/actix/dev/struct.SpawnHandle.html" title="struct actix_web::actix::actix::dev::SpawnHandle">SpawnHandle</a> <span class="where fmt-newline">where<br> A: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Handler.html" title="trait actix_web::actix::actix::dev::Handler">Handler</a><M>,<br> M: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Message.html" title="trait actix_web::actix::actix::dev::Message">Message</a> + 'static, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Send message <code>msg</code> to self after specified period of time. Returns spawn handle which could be used for cancellation. Notification get cancelled if context's stop method get called. <a href="../../actix_web/actix/actix/dev/trait.AsyncContext.html#method.notify_later">Read more</a></p>
|
||||
</div><h4 id='method.run_later' class="method"><span id='run_later.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.AsyncContext.html#method.run_later' class='fnname'>run_later</a><F>(&mut self, dur: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>, f: F) -> <a class="struct" href="../../actix_web/actix/actix/dev/struct.SpawnHandle.html" title="struct actix_web::actix::actix::dev::SpawnHandle">SpawnHandle</a> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A, &mut <A as <a class="trait" href="../../actix_web/actix/actix/trait.Actor.html" title="trait actix_web::actix::actix::Actor">Actor</a>>::<a class="type" href="../../actix_web/actix/actix/trait.Actor.html#associatedtype.Context" title="type actix_web::actix::actix::Actor::Context">Context</a>) + 'static, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Execute closure after specified period of time within same Actor and Context. Execution get cancelled if context's stop method get called. <a href="../../actix_web/actix/actix/dev/trait.AsyncContext.html#method.run_later">Read more</a></p>
|
||||
</div><h4 id='method.run_interval' class="method"><span id='run_interval.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.AsyncContext.html#method.run_interval' class='fnname'>run_interval</a><F>(&mut self, dur: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>, f: F) -> <a class="struct" href="../../actix_web/actix/actix/dev/struct.SpawnHandle.html" title="struct actix_web::actix::actix::dev::SpawnHandle">SpawnHandle</a> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A, &mut <A as <a class="trait" href="../../actix_web/actix/actix/trait.Actor.html" title="trait actix_web::actix::actix::Actor">Actor</a>>::<a class="type" href="../../actix_web/actix/actix/trait.Actor.html#associatedtype.Context" title="type actix_web::actix::actix::Actor::Context">Context</a>) + 'static, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Spawns job to execute closure with specified interval</p>
|
||||
</div></div><h3 id='impl-WsWriter' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, S> <a class="trait" href="../../actix_web/ws/trait.WsWriter.html" title="trait actix_web::ws::WsWriter">WsWriter</a> for <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, 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><Context = Self>,<br> S: 'static, </span></code><a href='#impl-WsWriter' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#236-270' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.send_text' class="method"><span id='send_text.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_text' class='fnname'>send_text</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, text: T)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#243-245' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send text frame</p>
|
||||
</div><h4 id='method.send_binary' class="method"><span id='send_binary.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_binary' class='fnname'>send_binary</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, data: B)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#249-251' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send binary frame</p>
|
||||
</div><h4 id='method.send_ping' class="method"><span id='send_ping.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_ping' class='fnname'>send_ping</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#255-257' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send ping frame</p>
|
||||
</div><h4 id='method.send_pong' class="method"><span id='send_pong.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_pong' class='fnname'>send_pong</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#261-263' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send pong frame</p>
|
||||
</div><h4 id='method.send_close' class="method"><span id='send_close.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/ws/trait.WsWriter.html#tymethod.send_close' class='fnname'>send_close</a>(&mut self, reason: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a>>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#267-269' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Send close frame</p>
|
||||
</div></div><h3 id='impl-AsyncContextParts%3CA%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, S> <a class="trait" href="../../actix_web/actix/actix/dev/trait.AsyncContextParts.html" title="trait actix_web::actix::actix::dev::AsyncContextParts">AsyncContextParts</a><A> for <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, 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><Context = Self>, </span></code><a href='#impl-AsyncContextParts%3CA%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#272-279' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.parts' class="method"><span id='parts.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.AsyncContextParts.html#tymethod.parts' class='fnname'>parts</a>(&mut self) -> &mut <a class="struct" href="../../actix_web/actix/actix/dev/struct.ContextParts.html" title="struct actix_web::actix::actix::dev::ContextParts">ContextParts</a><A></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#276-278' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div><h3 id='impl-ToEnvelope%3CA%2C%20M%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, M, S> <a class="trait" href="../../actix_web/actix/actix/dev/trait.ToEnvelope.html" title="trait actix_web::actix::actix::dev::ToEnvelope">ToEnvelope</a><A, M> for <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, 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><Context = <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S>> + <a class="trait" href="../../actix_web/actix/actix/dev/trait.Handler.html" title="trait actix_web::actix::actix::dev::Handler">Handler</a><M>,<br> M: <a class="trait" href="../../actix_web/actix/actix/dev/trait.Message.html" title="trait actix_web::actix::actix::dev::Message">ActixMessage</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,<br> M::<a class="type" href="../../actix_web/actix/actix/dev/trait.Message.html#associatedtype.Result" title="type actix_web::actix::actix::dev::Message::Result">Result</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-ToEnvelope%3CA%2C%20M%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#325-334' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.pack' class="method"><span id='pack.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/dev/trait.ToEnvelope.html#tymethod.pack' class='fnname'>pack</a>(msg: M, tx: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://docs.rs/futures/0.1/futures/sync/oneshot/struct.Sender.html" title="struct futures::sync::oneshot::Sender">Sender</a><M::<a class="type" href="../../actix_web/actix/actix/dev/trait.Message.html#associatedtype.Result" title="type actix_web::actix::actix::dev::Message::Result">Result</a>>>) -> <a class="struct" href="../../actix_web/actix/actix/dev/struct.Envelope.html" title="struct actix_web::actix::actix::dev::Envelope">Envelope</a><A></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/context.rs.html#331-333' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Pack message into suitable envelope</p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, S = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A, S = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, S></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
60
static/api/actix-web/0.7.0/stable/ws/struct.WsStream.html
Normal file
60
static/api/actix-web/0.7.0/stable/ws/struct.WsStream.html
Normal file
@ -0,0 +1,60 @@
|
||||
<!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 `WsStream` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, WsStream"><title>actix_web::ws::WsStream - 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 struct"><!--[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'>Struct WsStream</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.max_size">max_size</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Stream">Stream</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a></p><script>window.sidebarCurrent = {name: 'WsStream', ty: 'struct', 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'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>ws</a>::<wbr><a class="struct" href=''>WsStream</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><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#254-258' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct WsStream<S> { /* fields omitted */ }</pre></div><div class='docblock'><p>Maps <code>Payload</code> stream into stream of <code>ws::Message</code> items</p>
|
||||
</div>
|
||||
<h2 id='methods' class='small-section-header'>
|
||||
Methods<a href='#methods' class='anchor'></a>
|
||||
</h2>
|
||||
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<S> <a class="struct" href="../../actix_web/ws/struct.WsStream.html" title="struct actix_web::ws::WsStream">WsStream</a><S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = <a class="struct" href="https://docs.rs/bytes/0.4.8/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>, Error = <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>>, </span></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#260-280' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(stream: S) -> <a class="struct" href="../../actix_web/ws/struct.WsStream.html" title="struct actix_web::ws::WsStream">WsStream</a><S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#265-271' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create new websocket frames stream</p>
|
||||
</div><h4 id='method.max_size' class="method"><span id='max_size.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.max_size' class='fnname'>max_size</a>(self, size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#276-279' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set max frame size</p>
|
||||
<p>By default max size is set to 64kb</p>
|
||||
</div></div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-Stream' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<S> <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a> for <a class="struct" href="../../actix_web/ws/struct.WsStream.html" title="struct actix_web::ws::WsStream">WsStream</a><S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = <a class="struct" href="https://docs.rs/bytes/0.4.8/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>, Error = <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>>, </span></code><a href='#impl-Stream' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#282-342' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Item' class="type">Item</a> = <a class="enum" href="../../actix_web/ws/enum.Message.html" title="enum actix_web::ws::Message">Message</a></code></span></h4>
|
||||
<div class='docblock'><p>The type of item this stream will yield on success.</p>
|
||||
</div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="../../actix_web/ws/enum.ProtocolError.html" title="enum actix_web::ws::ProtocolError">ProtocolError</a></code></span></h4>
|
||||
<div class='docblock'><p>The type of error this stream may generate.</p>
|
||||
</div><h4 id='method.poll' class="method"><span id='poll.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#tymethod.poll' class='fnname'>poll</a>(&mut self) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<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>>, Self::<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>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#289-341' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempt to pull out the next value of this stream, returning <code>None</code> if the stream is finished. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#tymethod.poll">Read more</a></p>
|
||||
</div><h4 id='method.wait' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a><S></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a><S></h3><code class="content"><span class="where fmt-newline">impl<S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a><S> <span class="where fmt-newline">where<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><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</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>, <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></div></div><span id='wait.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.wait' class='fnname'>wait</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#244-248' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates an iterator which blocks the current thread until each item of this stream is resolved. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.wait">Read more</a></p>
|
||||
</div><h4 id='method.into_future' class="method"><span id='into_future.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.into_future' class='fnname'>into_future</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/future/struct.StreamFuture.html" title="struct futures::stream::future::StreamFuture">StreamFuture</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#291-295' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Converts this stream into a <code>Future</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.into_future">Read more</a></p>
|
||||
</div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.map' class='fnname'>map</a><U, F>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/map/struct.Map.html" title="struct futures::stream::map::Map">Map</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<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>) -> U, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#316-321' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Converts a stream of type <code>T</code> to a stream of type <code>U</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.map">Read more</a></p>
|
||||
</div><h4 id='method.map_err' class="method"><span id='map_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.map_err' class='fnname'>map_err</a><U, F>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/map_err/struct.MapErr.html" title="struct futures::stream::map_err::MapErr">MapErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<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>) -> U, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#342-347' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Converts a stream of error type <code>T</code> to a stream of error type <code>U</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.map_err">Read more</a></p>
|
||||
</div><h4 id='method.filter' class="method"><span id='filter.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.filter' class='fnname'>filter</a><F>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/filter/struct.Filter.html" title="struct futures::stream::filter::Filter">Filter</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<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>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#372-377' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Filters the values produced by this stream according to the provided predicate. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.filter">Read more</a></p>
|
||||
</div><h4 id='method.filter_map' class="method"><span id='filter_map.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.filter_map' class='fnname'>filter_map</a><F, B>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/filter_map/struct.FilterMap.html" title="struct futures::stream::filter_map::FilterMap">FilterMap</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<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>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><B>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#408-413' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Filters the values produced by this stream while simultaneously mapping them to a different type. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.filter_map">Read more</a></p>
|
||||
</div><h4 id='method.then' class="method"><span id='then.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.then' class='fnname'>then</a><F, U>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/then/struct.Then.html" title="struct futures::stream::then::Then">Then</a><Self, F, U> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<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>, Self::<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>>) -> U,<br> U: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#447-453' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Chain on a computation for when a value is ready, passing the resulting item to the provided closure <code>f</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.then">Read more</a></p>
|
||||
</div><h4 id='method.and_then' class="method"><span id='and_then.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.and_then' class='fnname'>and_then</a><F, U>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/and_then/struct.AndThen.html" title="struct futures::stream::and_then::AndThen">AndThen</a><Self, F, U> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<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>) -> U,<br> U: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#494-500' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Chain on a computation for when a value is ready, passing the successful results to the provided closure <code>f</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.and_then">Read more</a></p>
|
||||
</div><h4 id='method.or_else' class="method"><span id='or_else.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.or_else' class='fnname'>or_else</a><F, U>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/or_else/struct.OrElse.html" title="struct futures::stream::or_else::OrElse">OrElse</a><Self, F, U> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<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>) -> U,<br> U: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = Self::<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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#521-527' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Chain on a computation for when an error happens, passing the erroneous result to the provided closure <code>f</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.or_else">Read more</a></p>
|
||||
</div><h4 id='method.collect' class="method"><span id='collect.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.collect' class='fnname'>collect</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/collect/struct.Collect.html" title="struct futures::stream::collect::Collect">Collect</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#562-566' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Collect all of the values of this stream into a vector, returning a future representing the result of that computation. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.collect">Read more</a></p>
|
||||
</div><h4 id='method.concat2' class="method"><span id='concat2.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.concat2' class='fnname'>concat2</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/concat/struct.Concat2.html" title="struct futures::stream::concat::Concat2">Concat2</a><Self> <span class="where fmt-newline">where<br> Self::<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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.Extend.html" title="trait core::iter::traits::Extend">Extend</a><<Self::<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> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::IntoIterator::Item">Item</a>>,<br> Self::<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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>,<br> Self::<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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#598-603' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.concat2">Read more</a></p>
|
||||
</div><h4 id='method.concat' class="method"><span id='concat.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.concat' class='fnname'>concat</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/concat/struct.Concat.html" title="struct futures::stream::concat::Concat">Concat</a><Self> <span class="where fmt-newline">where<br> Self::<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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.Extend.html" title="trait core::iter::traits::Extend">Extend</a><<Self::<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> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::IntoIterator::Item">Item</a>>,<br> Self::<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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#638-643' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab deprecated'>Deprecated since 0.1.14<p>: please use <code>Stream::concat2</code> instead</p>
|
||||
</div></div><div class='docblock'><p>Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.concat">Read more</a></p>
|
||||
</div><h4 id='method.fold' class="method"><span id='fold.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.fold' class='fnname'>fold</a><F, T, Fut>(self, init: T, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/fold/struct.Fold.html" title="struct futures::stream::fold::Fold">Fold</a><Self, F, Fut, T> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(T, Self::<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>) -> Fut,<br> Fut: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = T>,<br> Self::<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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<Fut as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Error" title="type futures::future::IntoFuture::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#668-675' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Execute an accumulating computation over a stream, collecting all the values into one final result. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.fold">Read more</a></p>
|
||||
</div><h4 id='method.flatten' class="method"><span id='flatten.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.flatten' class='fnname'>flatten</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/flatten/struct.Flatten.html" title="struct futures::stream::flatten::Flatten">Flatten</a><Self> <span class="where fmt-newline">where<br> Self::<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>: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>,<br> <Self::<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> 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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#710-716' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Flattens a stream of streams into just one continuous stream. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.flatten">Read more</a></p>
|
||||
</div><h4 id='method.skip_while' class="method"><span id='skip_while.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.skip_while' class='fnname'>skip_while</a><P, R>(self, pred: P) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/skip_while/struct.SkipWhile.html" title="struct futures::stream::skip_while::SkipWhile">SkipWhile</a><Self, P, R> <span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<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>) -> R,<br> R: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#725-731' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Skip elements on this stream while the predicate provided resolves to <code>true</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.skip_while">Read more</a></p>
|
||||
</div><h4 id='method.take_while' class="method"><span id='take_while.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.take_while' class='fnname'>take_while</a><P, R>(self, pred: P) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/take_while/struct.TakeWhile.html" title="struct futures::stream::take_while::TakeWhile">TakeWhile</a><Self, P, R> <span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<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>) -> R,<br> R: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#739-745' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Take elements from this stream while the predicate provided resolves to <code>true</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.take_while">Read more</a></p>
|
||||
</div><h4 id='method.for_each' class="method"><span id='for_each.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.for_each' class='fnname'>for_each</a><F, U>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/for_each/struct.ForEach.html" title="struct futures::stream::for_each::ForEach">ForEach</a><Self, F, U> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<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>) -> U,<br> U: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#761-767' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Runs this stream to completion, executing the provided closure for each element on the stream. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.for_each">Read more</a></p>
|
||||
</div><h4 id='method.from_err' class="method"><span id='from_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.from_err' class='fnname'>from_err</a><E>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/from_err/struct.FromErr.html" title="struct futures::stream::from_err::FromErr">FromErr</a><Self, E> <span class="where fmt-newline">where<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#780-784' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Map this stream's error to any error implementing <code>From</code> for this stream's <code>Error</code>, returning a new stream. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.from_err">Read more</a></p>
|
||||
</div><h4 id='method.take' class="method"><span id='take.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.take' class='fnname'>take</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/take/struct.Take.html" title="struct futures::stream::take::Take">Take</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#796-800' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new stream of at most <code>amt</code> items of the underlying stream. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.take">Read more</a></p>
|
||||
</div><h4 id='method.skip' class="method"><span id='skip.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.skip' class='fnname'>skip</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/skip/struct.Skip.html" title="struct futures::stream::skip::Skip">Skip</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#811-815' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new stream which skips <code>amt</code> items of the underlying stream. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.skip">Read more</a></p>
|
||||
</div><h4 id='method.fuse' class="method"><span id='fuse.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.fuse' class='fnname'>fuse</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/fuse/struct.Fuse.html" title="struct futures::stream::fuse::Fuse">Fuse</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#832-836' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Fuse a stream such that <code>poll</code> will never again be called once it has finished. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.fuse">Read more</a></p>
|
||||
</div><h4 id='method.by_ref' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='by_ref.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.by_ref' class='fnname'>by_ref</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#857-861' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Borrows a stream, rather than consuming it. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.by_ref">Read more</a></p>
|
||||
</div><h4 id='method.catch_unwind' class="method"><span id='catch_unwind.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.catch_unwind' class='fnname'>catch_unwind</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/catch_unwind/struct.CatchUnwind.html" title="struct futures::stream::catch_unwind::CatchUnwind">CatchUnwind</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#897-901' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Catches unwinding panics while polling the stream. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.catch_unwind">Read more</a></p>
|
||||
</div><h4 id='method.buffered' class="method"><span id='buffered.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.buffered' class='fnname'>buffered</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/buffered/struct.Buffered.html" title="struct futures::stream::buffered::Buffered">Buffered</a><Self> <span class="where fmt-newline">where<br> Self::<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>: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>,<br> <Self::<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> as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Error" title="type futures::future::IntoFuture::Error">Error</a> == Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#917-922' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>An adaptor for creating a buffered list of pending futures. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.buffered">Read more</a></p>
|
||||
</div><h4 id='method.buffer_unordered' class="method"><span id='buffer_unordered.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.buffer_unordered' class='fnname'>buffer_unordered</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/buffer_unordered/struct.BufferUnordered.html" title="struct futures::stream::buffer_unordered::BufferUnordered">BufferUnordered</a><Self> <span class="where fmt-newline">where<br> Self::<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>: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>,<br> <Self::<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> as <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/future/trait.IntoFuture.html#associatedtype.Error" title="type futures::future::IntoFuture::Error">Error</a> == Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#938-943' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>An adaptor for creating a buffered list of pending futures (unordered). <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.buffer_unordered">Read more</a></p>
|
||||
</div><h4 id='method.merge' class="method"><span id='merge.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.merge' class='fnname'>merge</a><S>(self, other: S) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/merge/struct.Merge.html" title="struct futures::stream::merge::Merge">Merge</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#952-957' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab deprecated'>Deprecated<p>: functionality provided by <code>select</code> now</p>
|
||||
</div></div><div class='docblock'><p>An adapter for merging the output of two streams. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.merge">Read more</a></p>
|
||||
</div><h4 id='method.zip' class="method"><span id='zip.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.zip' class='fnname'>zip</a><S>(self, other: S) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/zip/struct.Zip.html" title="struct futures::stream::zip::Zip">Zip</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#964-969' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>An adapter for zipping two streams together. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.zip">Read more</a></p>
|
||||
</div><h4 id='method.chain' class="method"><span id='chain.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.chain' class='fnname'>chain</a><S>(self, other: S) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/chain/struct.Chain.html" title="struct futures::stream::chain::Chain">Chain</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = Self::<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>, Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#990-995' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Adapter for chaining two stream. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.chain">Read more</a></p>
|
||||
</div><h4 id='method.peekable' class="method"><span id='peekable.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.peekable' class='fnname'>peekable</a>(self) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/peek/struct.Peekable.html" title="struct futures::stream::peek::Peekable">Peekable</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#1000-1004' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new stream which exposes a <code>peek</code> method. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.peekable">Read more</a></p>
|
||||
</div><h4 id='method.chunks' class="method"><span id='chunks.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.chunks' class='fnname'>chunks</a>(self, capacity: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/chunks/struct.Chunks.html" title="struct futures::stream::chunks::Chunks">Chunks</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#1027-1031' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>An adaptor for chunking up items of the stream inside a vector. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.chunks">Read more</a></p>
|
||||
</div><h4 id='method.select' class="method"><span id='select.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.select' class='fnname'>select</a><S>(self, other: S) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/select/struct.Select.html" title="struct futures::stream::select::Select">Select</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = Self::<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>, Error = Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#1044-1049' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.select">Read more</a></p>
|
||||
</div><h4 id='method.forward' class="method"><span id='forward.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.forward' class='fnname'>forward</a><S>(self, sink: S) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/forward/struct.Forward.html" title="struct futures::stream::forward::Forward">Forward</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a><SinkItem = Self::<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>>,<br> Self::<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>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<S as <a class="trait" href="https://docs.rs/futures/0.1/futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>>::<a class="type" href="https://docs.rs/futures/0.1/futures/sink/trait.Sink.html#associatedtype.SinkError" title="type futures::sink::Sink::SinkError">SinkError</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#1065-1071' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>A future that completes after the given stream has been fully processed into the sink, including flushing. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.forward">Read more</a></p>
|
||||
</div><h4 id='method.split' class="method"><span id='split.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.split' class='fnname'>split</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="https://docs.rs/futures/0.1/futures/stream/split/struct.SplitSink.html" title="struct futures::stream::split::SplitSink">SplitSink</a><Self>, <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/split/struct.SplitStream.html" title="struct futures::stream::split::SplitStream">SplitStream</a><Self><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://docs.rs/futures/0.1/futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#1083-1087' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Splits this <code>Stream + Sink</code> object into separate <code>Stream</code> and <code>Sink</code> objects. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.split">Read more</a></p>
|
||||
</div><h4 id='method.inspect' class="method"><span id='inspect.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.inspect' class='fnname'>inspect</a><F>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/inspect/struct.Inspect.html" title="struct futures::stream::inspect::Inspect">Inspect</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#1094-1099' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Do something with each item of this stream, afterwards passing it on. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.inspect">Read more</a></p>
|
||||
</div><h4 id='method.inspect_err' class="method"><span id='inspect_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.inspect_err' class='fnname'>inspect_err</a><F>(self, f: F) -> <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/inspect_err/struct.InspectErr.html" title="struct futures::stream::inspect_err::InspectErr">InspectErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#1106-1111' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Do something with the error of this stream, afterwards passing it on. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.inspect_err">Read more</a></p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='synthetic-implementations-list'>
|
||||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../actix_web/ws/struct.WsStream.html" title="struct actix_web::ws::WsStream">WsStream</a><S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../actix_web/ws/struct.WsStream.html" title="struct actix_web::ws::WsStream">WsStream</a><S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|
||||
27
static/api/actix-web/0.7.0/stable/ws/trait.WsWriter.html
Normal file
27
static/api/actix-web/0.7.0/stable/ws/trait.WsWriter.html
Normal file
@ -0,0 +1,27 @@
|
||||
<!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 `WsWriter` trait in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, WsWriter"><title>actix_web::ws::WsWriter - 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 WsWriter</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.send_text">send_text</a><a href="#tymethod.send_binary">send_binary</a><a href="#tymethod.send_ping">send_ping</a><a href="#tymethod.send_pong">send_pong</a><a href="#tymethod.send_close">send_close</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'>ws</a></p><script>window.sidebarCurrent = {name: 'WsWriter', 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'>ws</a>::<wbr><a class="trait" href=''>WsWriter</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><a class='srclink' href='../../src/actix_web/ws/mod.rs.html#345-356' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait WsWriter {
|
||||
fn <a href='#tymethod.send_text' class='fnname'>send_text</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, text: T);
|
||||
<div class='item-spacer'></div> fn <a href='#tymethod.send_binary' class='fnname'>send_binary</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, data: B);
|
||||
<div class='item-spacer'></div> fn <a href='#tymethod.send_ping' class='fnname'>send_ping</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>);
|
||||
<div class='item-spacer'></div> fn <a href='#tymethod.send_pong' class='fnname'>send_pong</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>);
|
||||
<div class='item-spacer'></div> fn <a href='#tymethod.send_close' class='fnname'>send_close</a>(&mut self, reason: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a>>);
|
||||
}</pre></div><div class='docblock'><p>Common writing methods for a websocket.</p>
|
||||
</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.send_text' class='method'><span id='send_text.v' class='invisible'><code>fn <a href='#tymethod.send_text' class='fnname'>send_text</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, text: T)</code></span></h3><div class='docblock'><p>Send a text</p>
|
||||
</div><h3 id='tymethod.send_binary' class='method'><span id='send_binary.v' class='invisible'><code>fn <a href='#tymethod.send_binary' class='fnname'>send_binary</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../actix_web/enum.Binary.html" title="enum actix_web::Binary">Binary</a>>>(&mut self, data: B)</code></span></h3><div class='docblock'><p>Send a binary</p>
|
||||
</div><h3 id='tymethod.send_ping' class='method'><span id='send_ping.v' class='invisible'><code>fn <a href='#tymethod.send_ping' class='fnname'>send_ping</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></h3><div class='docblock'><p>Send a ping message</p>
|
||||
</div><h3 id='tymethod.send_pong' class='method'><span id='send_pong.v' class='invisible'><code>fn <a href='#tymethod.send_pong' class='fnname'>send_pong</a>(&mut self, message: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></h3><div class='docblock'><p>Send a pong message</p>
|
||||
</div><h3 id='tymethod.send_close' class='method'><span id='send_close.v' class='invisible'><code>fn <a href='#tymethod.send_close' class='fnname'>send_close</a>(&mut self, reason: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_web/ws/struct.CloseReason.html" title="struct actix_web::ws::CloseReason">CloseReason</a>>)</code></span></h3><div class='docblock'><p>Close the connection</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 WsWriter for <a class="struct" href="../../actix_web/ws/struct.ClientWriter.html" title="struct actix_web::ws::ClientWriter">ClientWriter</a></code><td><div class='out-of-band'><a class='srclink' href='../../src/actix_web/ws/client.rs.html#572-602' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||||
<li><table class='table-display'><tbody><tr><td><code>impl<A, S> WsWriter for <a class="struct" href="../../actix_web/ws/struct.WebsocketContext.html" title="struct actix_web::ws::WebsocketContext">WebsocketContext</a><A, 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><Context = Self>,<br> S: 'static, </span></code><td><div class='out-of-band'><a class='srclink' href='../../src/actix_web/ws/context.rs.html#236-270' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||||
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||||
src="../../implementors/actix_web/ws/trait.WsWriter.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>
|
||||
Reference in New Issue
Block a user