2018-10-10 17:38:33 +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 = "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 ‘ ’ ‘ ’ 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 = '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 > < 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 > < / h1 > < div class = "docblock type-decl hidden-by-usual-hider" > < pre class = 'rust trait' > pub trait WsWriter {
2018-07-21 13:09:47 +02:00
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 >
2018-10-10 17:38:33 +02:00
< / div > < / div > < h2 id = 'implementors' class = 'small-section-header' > Implementors< a href = '#implementors' class = 'anchor' > < / a > < / h2 > < div class = 'item-list' id = 'implementors-list' > < h3 id = 'impl-WsWriter' class = 'impl' > < span class = 'in-band' > < 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 > < 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-1' class = 'invisible' > < table class = 'table-display' > < tbody > < tr > < td > < code > fn < a href = '#method.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-1' class = 'invisible' > < table class = 'table-display' > < tbody > < tr > < td > < code > fn < a href = '#method.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-1' class = 'invisible' > < table class = 'table-display' > < tbody > < tr > < td > < code > fn < a href = '#method.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-1' class = 'invisible' > < table class = 'table-display' > < tbody > < tr > < td > < code > fn < a href = '#method.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-1' class = 'invisible' > < table class = 'table-display' > < tbody > < tr > < td > < code > fn < a href = '#method.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 > < h3 id = 'impl-WsWriter-1' class = 'impl' > < span class = 'in-band' > < 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/dev/trait.Actor.html" title = "trait actix_web::actix::actix::dev::Actor" > Actor< / a > < Context = Self> ,< br > S: 'static, < / span > < / code > < a href = '#impl-WsWriter-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#236-270' title = 'goto source code' > [src]< / a > < / span > < / td > < / tr > < / tbody > < / table > < / h3 > < div class = 'impl-items' > < h4 id = 'method.send_text-1' class = "method" > < span id = 'send_text.v-2' class = 'invisible' > < table class = 'table-display' > < tbody > < tr > < td > < code > fn < a href = '#method.send_text-1' 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-1' class = "method" > < span id = 'send_binary.v-2' class = 'invisible' > < table class = 'table-display' > < tbody > < tr > < td > < code > fn < a href = '#method.send_binary-1' 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-1' class = "method" > < span id = 'send_ping.v-2' class = 'invisible' > < table class = 'table-display' > < tbody > < tr > < td > < code > fn < a href = '#method.send_ping-1' 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-1' class = "method" > < span id = 'send_pong.v-2' class = 'invisible' > < table class = 'table-display' > < tbody > < tr > < td > < code > fn < a href = '#method.send_pong-1' 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-1' class = "method" > < span id = 'send_close.v-2' class = 'invisible' > < table class = 'table-display' > < tbody > < tr > < td > < code > fn < a href = '#method.send_close-1' 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 > < / div > < script type = "text/javascript" > window . inlined _types = new Set ( [ ] ) ; < / script > < script type = "text/javascript" async
2018-07-21 13:09:47 +02:00
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 >
