Struct evzht9h3nznqzwl::codec::ws::MessageCodec
[−]
[src]
pub struct MessageCodec<M> where
M: MessageTrait, { /* fields omitted */ }
A codec for asynchronously decoding and encoding websocket messages.
This codec decodes messages into the OwnedMessage
struct, so using this
the user will receive messages as OwnedMessage
s. However it can encode
any type of message that implements the ws::Message
trait (that type is
decided by the M
type parameter) like OwnedMessage
and Message
.
Warning: if you don't know what your doing or want a simple websocket connection
please use the ClientBuilder
or the Server
structs. You should only use this
after a websocket handshake has already been completed on the stream you are
using.
Example
use websocket::async::{MessageCodec, MsgCodecCtx}; let mut core = Core::new().unwrap(); let mut input = Vec::new(); Message::text("50 schmeckels").serialize(&mut input, false); let f = ReadWritePair(Cursor::new(input), Cursor::new(vec![])) .framed(MessageCodec::default(MsgCodecCtx::Client)) .into_future() .map_err(|e| e.0) .map(|(m, _)| { assert_eq!(m, Some(OwnedMessage::Text("50 schmeckels".to_string()))); }); core.run(f).unwrap();
Methods
impl MessageCodec<OwnedMessage>
[src]
fn default(context: Context) -> Self
[src]
Create a new MessageCodec
with a role of context
(either Client
or Server
) to read and write messages asynchronously.
This will create the crate's default codec which sends and receives
OwnedMessage
structs. The message data has to be sent to an intermediate
buffer anyway so sending owned data is preferable.
If you have your own implementation of websocket messages, you can
use the new
method to create a codec for that implementation.
impl<M> MessageCodec<M> where
M: MessageTrait,
[src]
M: MessageTrait,
fn new(context: Context) -> MessageCodec<M>
[src]
Creates a codec that can encode a custom implementation of a websocket message.
If you just want to use a normal codec without a specific implementation
of a websocket message, take a look at MessageCodec::default
.
Trait Implementations
impl<M> Decoder for MessageCodec<M> where
M: MessageTrait,
[src]
M: MessageTrait,
type Item = OwnedMessage
The type of decoded frames.
type Error = WebSocketError
The type of unrecoverable frame decoding errors. Read more
fn decode(
&mut self,
src: &mut BytesMut
) -> Result<Option<Self::Item>, Self::Error>
[src]
&mut self,
src: &mut BytesMut
) -> Result<Option<Self::Item>, Self::Error>
Attempts to decode a frame from the provided buffer of bytes. Read more
fn decode_eof(
&mut self,
buf: &mut BytesMut
) -> Result<Option<Self::Item>, Self::Error>
[src]
&mut self,
buf: &mut BytesMut
) -> Result<Option<Self::Item>, Self::Error>
A default method available to be called when there are no more bytes available to be read from the underlying I/O. Read more
impl<M> Encoder for MessageCodec<M> where
M: MessageTrait,
[src]
M: MessageTrait,