pub enum Message {
Text(String),
Binary(Vec<u8, Global>),
Ping(Vec<u8, Global>),
Pong(Vec<u8, Global>),
Close(Option<CloseFrame<'static>>),
Frame(Frame),
}
Expand description
An enum representing the various forms of a WebSocket message.
Variants
Text(String)
A text WebSocket message
Binary(Vec<u8, Global>)
A binary WebSocket message
Ping(Vec<u8, Global>)
A ping message with the specified payload
The payload here must have a length less than 125 bytes
Pong(Vec<u8, Global>)
A pong message with the specified payload
The payload here must have a length less than 125 bytes
Close(Option<CloseFrame<'static>>)
A close message with the optional close frame.
Frame(Frame)
Raw frame. Note, that you’re not going to get this value while reading the message.
Implementations
sourceimpl Message
impl Message
sourcepub fn text<S>(string: S) -> Message where
S: Into<String>,
pub fn text<S>(string: S) -> Message where
S: Into<String>,
Create a new text WebSocket message from a stringable.
sourcepub fn binary<B>(bin: B) -> Message where
B: Into<Vec<u8, Global>>,
pub fn binary<B>(bin: B) -> Message where
B: Into<Vec<u8, Global>>,
Create a new binary WebSocket message by converting to Vec
sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Returns true if the WebSocket message has no content. For example, if the other side of the connection sent an empty string.
sourcepub fn into_data(self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
pub fn into_data(self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Consume the WebSocket and return it as binary data.
Trait Implementations
impl Eq for Message
impl StructuralEq for Message
impl StructuralPartialEq for Message
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more