<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="WebSockets for Actix Web, without actors."><title>actix_ws - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-c67e44d78ab2db17.css"><metaname="rustdoc-vars"data-root-path="../"data-static-root-path="../static.files/"data-current-crate="actix_ws"data-themes=""data-resource-suffix=""data-rustdoc-version="1.76.0-nightly (e9013ac0e 2023-12-05)"data-channel="nightly"data-search-js="search-5a66c239c06b3a66.js"data-settings-js="settings-fe03fdc259827cd2.js"><scriptsrc="../static.files/storage-fec3eaa3851e447d.js"></script><scriptdefersrc="../crates.js"></script><scriptdefersrc="../static.files/main-77dede896d6ac08e.js"></script><noscript><linkrel="stylesheet"href="../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><linkrel="icon"href="https://actix.rs/favicon.ico"></head><bodyclass="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="logo-container"href="../actix_ws/index.html"><imgsrc="https://actix.rs/img/logo.png"alt=""></a></nav><navclass="sidebar"><divclass="sidebar-crate"><aclass="logo-container"href="../actix_ws/index.html"><imgsrc="https://actix.rs/img/logo.png"alt="logo"></a><h2><ahref="../actix_ws/index.html">actix_ws</a><spanclass="version">0.2.0</span></h2></div><divclass="sidebar-elems"><ulclass="block">
<li><aid="all-types"href="all.html">All Items</a></li></ul><section><ulclass="block"><li><ahref="#structs">Structs</a></li><li><ahref="#enums">Enums</a></li><li><ahref="#functions">Functions</a></li></ul></section></div></nav><main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"title="help"tabindex="-1"><ahref="../help.html">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Crate <aclass="mod"href="#">actix_ws</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../src/actix_ws/lib.rs.html#1-84">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>WebSockets for Actix Web, without actors.</p>
<p>For usage, see documentation on <ahref="fn.handle.html"title="fn actix_ws::handle"><code>handle()</code></a>.</p>
</div></details><h2id="structs"class="section-header"><ahref="#structs">Structs</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.CloseReason.html"title="struct actix_ws::CloseReason">CloseReason</a></div><divclass="desc docblock-short">Reason for closing the connection</div></li><li><divclass="item-name"><aclass="struct"href="struct.Closed.html"title="struct actix_ws::Closed">Closed</a></div><divclass="desc docblock-short">The error representing a closed websocket session</div></li><li><divclass="item-name"><aclass="struct"href="struct.MessageStream.html"title="struct actix_ws::MessageStream">MessageStream</a></div><divclass="desc docblock-short">A stream of Messages from a websocket client</div></li><li><divclass="item-name"><aclass="struct"href="struct.Session.html"title="struct actix_ws::Session">Session</a></div><divclass="desc docblock-short">A handle into the websocket session.</div></li><li><divclass="item-name"><aclass="struct"href="struct.StreamingBody.html"title="struct actix_ws::StreamingBody">StreamingBody</a></div><divclass="desc docblock-short">A response body for Websocket HTTP Requests</div></li></ul><h2id="enums"class="section-header"><ahref="#enums">Enums</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="enum"href="enum.CloseCode.html"title="enum actix_ws::CloseCode">CloseCode</a></div><divclass="desc docblock-short">Status code used to indicate why an endpoint is closing the WebSocket connection.</div></li><li><divclass="item-name"><aclass="enum"href="enum.Message.html"title="enum actix_ws::Message">Message</a></div><divclass="desc docblock-short">A WebSocket message.</div></li><li><divclass="item-name"><aclass="enum"href="enum.ProtocolError.html"title="enum actix_ws::ProtocolError">ProtocolError</a></div><divclass="desc docblock-short">WebSocket protocol errors.</div></li></ul><h2id="functions"class="section-header"><ahref="#functions">Functions</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="fn"href="fn.handle.html"title="fn actix_ws::handle">handle</a></div><divclass="desc docblock-short">Begin handling websocket traffic</div></li></ul></section></div></main></body></html>
