[−][src]Struct websocket_codec::Message
A text string, a block of binary data or a WebSocket control frame.
Implementations
impl Message
[src]
pub fn new<B: Into<Bytes>>(opcode: Opcode, data: B) -> Result<Self, Utf8Error>
[src]
Creates a message from a Bytes
object.
The message can be tagged as text or binary. When the opcode
parameter is Opcode::Text
this function validates the bytes in data
and returns Err
if they do not contain valid UTF-8 text.
pub fn text<S: Into<String>>(data: S) -> Self
[src]
Creates a text message from a String
.
pub fn binary<B: Into<Bytes>>(data: B) -> Self
[src]
Creates a binary message from any type that can be converted to Bytes
, such as &[u8]
or Vec<u8>
.
pub fn close(reason: Option<(u16, String)>) -> Self
[src]
Creates a message that indicates the connection is about to be closed.
The reason
parameter is an optional numerical status code and text description. Valid reasons
may be defined by a particular WebSocket server.
pub fn ping<B: Into<Bytes>>(data: B) -> Self
[src]
Creates a message requesting a pong response.
The client can send one of these to request a pong response from the server.
pub fn pong<B: Into<Bytes>>(data: B) -> Self
[src]
Creates a response to a ping message.
The client can send one of these in response to a ping from the server.
pub fn opcode(&self) -> Opcode
[src]
Returns this message's WebSocket opcode.
pub fn data(&self) -> &Bytes
[src]
Returns a reference to the data held in this message.
pub fn into_data(self) -> Bytes
[src]
Consumes the message, returning its data.
pub fn as_text(&self) -> Option<&str>
[src]
For messages with opcode Opcode::Text
, returns a reference to the text.
Returns None
otherwise.
Trait Implementations
impl Clone for Message
[src]
impl Debug for Message
[src]
impl<'a> Encoder<&'a Message> for MessageCodec
[src]
type Error = Error
The type of encoding errors. Read more
fn encode(&mut self, item: &Message, dst: &mut BytesMut) -> Result<()>
[src]
impl Encoder<Message> for MessageCodec
[src]
type Error = Error
The type of encoding errors. Read more
fn encode(&mut self, item: Message, dst: &mut BytesMut) -> Result<()>
[src]
impl PartialEq<Message> for Message
[src]
impl StructuralPartialEq for Message
[src]
Auto Trait Implementations
impl RefUnwindSafe for Message
impl Send for Message
impl Sync for Message
impl Unpin for Message
impl UnwindSafe for Message
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,