2024-04-09 12:20:01 +02:00
<!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 = "Begin handling websocket traffic" > < title > handle in actix_ws - Rust< / title > < script > if ( window . location . protocol !== "file:" ) document . write ( ` <link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"> ` ) < / script > < link rel = "stylesheet" href = "../static.files/normalize-76eba96aa4d2e634.css" > < link rel = "stylesheet" href = "../static.files/rustdoc-9e1300b5663a8a03.css" > < meta name = "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.79.0-nightly (ab5bda1aa 2024-04-08)" data-channel = "nightly" data-search-js = "search-ffac13a0df2b1870.js" data-settings-js = "settings-4313503d2e1961c2.js" > < script src = "../static.files/storage-e32f0c247825364d.js" > < / script > < script defer src = "sidebar-items.js" > < / script > < script defer src = "../static.files/main-c97aec732c613ca4.js" > < / script > < noscript > < link rel = "stylesheet" href = "../static.files/noscript-09095024cf37855e.css" > < / noscript > < link rel = "icon" href = "https://actix.rs/favicon.ico" > < / head > < body class = "rustdoc fn" > <!-- [if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif] --> < nav class = "mobile-topbar" > < button class = "sidebar-menu-toggle" title = "show sidebar" > < / button > < a class = "logo-container" href = "../actix_ws/index.html" > < img src = "https://actix.rs/img/logo.png" alt = "" > < / a > < / nav > < nav class = "sidebar" > < div class = "sidebar-crate" > < a class = "logo-container" href = "../actix_ws/index.html" > < img src = "https://actix.rs/img/logo.png" alt = "logo" > < / a > < h2 > < a href = "../actix_ws/index.html" > actix_ws< / a > < span class = "version" > 0.2.0< / span > < / h2 > < / div > < div class = "sidebar-elems" > < / div > < / nav > < div class = "sidebar-resizer" > < / div >
2023-12-18 17:32:00 +01:00
< main > < div class = "width-limiter" > < nav class = "sub" > < form class = "search-form" > < span > < / span > < div id = "sidebar-button" tabindex = "-1" > < a href = "../actix_ws/all.html" title = "show sidebar" > < / a > < / div > < input class = "search-input" name = "search" aria-label = "Run search in the documentation" autocomplete = "off" spellcheck = "false" placeholder = "Click or press ‘ ’ ‘ ’ type = "search" > < div id = "help-button" tabindex = "-1" > < a href = "../help.html" title = "help" > ?< / a > < / div > < div id = "settings-menu" tabindex = "-1" > < a href = "../settings.html" title = "settings" > < img width = "22" height = "22" alt = "Change settings" src = "../static.files/wheel-7b819b6101059cd0.svg" > < / a > < / div > < / form > < / nav > < section id = "main-content" class = "content" > < div class = "main-heading" > < h1 > Function < a href = "index.html" > actix_ws< / a > ::< wbr > < a class = "fn" href = "#" > handle< / a > < button id = "copy-path" title = "Copy item path to clipboard" > < img src = "../static.files/clipboard-7571035ce49a181d.svg" width = "19" height = "18" alt = "Copy item path" > < / button > < / h1 > < span class = "out-of-band" > < a class = "src" href = "../src/actix_ws/lib.rs.html#70-84" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub fn handle(
2023-11-03 23:49:56 +01:00
req: & HttpRequest,
body: Payload
) -> < a class = "enum" href = "https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < (HttpResponse, < a class = "struct" href = "struct.Session.html" title = "struct actix_ws::Session" > Session< / a > , < a class = "struct" href = "struct.MessageStream.html" title = "struct actix_ws::MessageStream" > MessageStream< / a > ), Error> < / code > < / pre > < details class = "toggle top-doc" open > < summary class = "hideme" > < span > Expand description< / span > < / summary > < div class = "docblock" > < p > Begin handling websocket traffic< / p >
< div class = "example-wrap" > < pre class = "rust rust-example-rendered" > < code > < span class = "kw" > use < / span > actix_web::{middleware::Logger, web, App, Error, HttpRequest, HttpResponse, HttpServer};
< span class = "kw" > use < / span > actix_ws::Message;
2024-03-02 22:47:06 +01:00
< span class = "kw" > use < / span > futures_util::StreamExt < span class = "kw" > as _< / span > ;
2023-11-03 23:49:56 +01:00
< span class = "kw" > async fn < / span > ws(req: HttpRequest, body: web::Payload) -> < span class = "prelude-ty" > Result< / span > < HttpResponse, Error> {
< span class = "kw" > let < / span > (response, < span class = "kw-2" > mut < / span > session, < span class = "kw-2" > mut < / span > msg_stream) = actix_ws::handle(< span class = "kw-2" > & < / span > req, body)< span class = "question-mark" > ?< / span > ;
actix_rt::spawn(< span class = "kw" > async move < / span > {
< span class = "kw" > while let < / span > < span class = "prelude-val" > Some< / span > (< span class = "prelude-val" > Ok< / span > (msg)) = msg_stream.next().< span class = "kw" > await < / span > {
< span class = "kw" > match < / span > msg {
Message::Ping(bytes) => {
< span class = "kw" > if < / span > session.pong(< span class = "kw-2" > & < / span > bytes).< span class = "kw" > await< / span > .is_err() {
< span class = "kw" > return< / span > ;
}
}
2023-12-06 15:01:24 +01:00
Message::Text(s) => < span class = "macro" > println!< / span > (< span class = "string" > "Got text, {}"< / span > , s),
2023-11-03 23:49:56 +01:00
< span class = "kw" > _ < / span > => < span class = "kw" > break< / span > ,
}
}
< span class = "kw" > let _ < / span > = session.close(< span class = "prelude-val" > None< / span > ).< span class = "kw" > await< / span > ;
});
< span class = "prelude-val" > Ok< / span > (response)
}
< span class = "attr" > #[actix_rt::main]
< / span > < span class = "kw" > async fn < / span > main() -> < span class = "prelude-ty" > Result< / span > < (), anyhow::Error> {
HttpServer::new(< span class = "kw" > move < / span > || {
App::new()
.wrap(Logger::default())
2023-12-06 15:01:24 +01:00
.route(< span class = "string" > "/ws"< / span > , web::get().to(ws))
2023-11-03 23:49:56 +01:00
})
2023-12-06 15:01:24 +01:00
.bind(< span class = "string" > "127.0.0.1:8080"< / span > )< span class = "question-mark" > ?
2023-11-03 23:49:56 +01:00
< / span > .run()
.< span class = "kw" > await< / span > < span class = "question-mark" > ?< / span > ;
< span class = "prelude-val" > Ok< / span > (())
}< / code > < / pre > < / div >
< / div > < / details > < / section > < / div > < / main > < / body > < / html >
