Enum lnkit::prelude::Message [−]
pub enum Message { Text(String), Binary(Vec<u8, Global>), Ping(Vec<u8, Global>), Pong(Vec<u8, Global>), Close(Option<CloseFrame<'static>>), }
An enum representing the various forms of a WebSocket message.
Variants
Text(String)
A text WebSocket message
A binary WebSocket message
A ping message with the specified payload
The payload here must have a length less than 125 bytes
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.
Implementations
impl Message
impl Message
pub fn text<S>(string: S) -> Message where
S: Into<String>,
S: Into<String>,
Create a new text WebSocket message from a stringable.
pub fn binary<B>(bin: B) -> Message where
B: Into<Vec<u8, Global>>,
B: Into<Vec<u8, Global>>,
Create a new binary WebSocket message by converting to Vec
pub fn is_text(&self) -> bool
Indicates whether a message is a text message.
pub fn is_binary(&self) -> bool
Indicates whether a message is a binary message.
pub fn is_ping(&self) -> bool
Indicates whether a message is a ping message.
pub fn is_pong(&self) -> bool
Indicates whether a message is a pong message.
pub fn is_close(&self) -> bool
Indicates whether a message ia s close message.
pub fn len(&self) -> usize
Get the length of the WebSocket message.
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.
pub fn into_data(self) -> Vec<u8, Global>
Consume the WebSocket and return it as binary data.
pub fn into_text(self) -> Result<String, Error>
Attempt to consume the WebSocket message and convert it to a String.
pub fn to_text(&self) -> Result<&str, Error>
Attempt to get a &str from the WebSocket message, this will try to convert binary data to utf8.
Trait Implementations
impl Clone for Message
impl Clone for Message
pub fn clone(&self) -> Message
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl StructuralEq for Message
impl StructuralEq for Message
impl StructuralPartialEq for Message
impl StructuralPartialEq for Message
Auto Trait Implementations
impl RefUnwindSafe for Message
impl RefUnwindSafe for Message
impl UnwindSafe for Message
impl UnwindSafe for Message
Blanket Implementations
impl<T, U> Cast<U> for T where
U: FromCast<T>,
impl<T, U> Cast<U> for T where
U: FromCast<T>,
pub fn cast(self) -> U
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
impl<T> FromBits<T> for T
impl<T> FromBits<T> for T
pub fn from_bits(t: T) -> T
impl<T> FromCast<T> for T
impl<T> FromCast<T> for T
pub fn from_cast(t: T) -> T
impl<T, U> IntoBits<U> for T where
U: FromBits<T>,
impl<T, U> IntoBits<U> for T where
U: FromBits<T>,
pub fn into_bits(self) -> U
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn is_in_subset(&self) -> bool
pub fn to_subset_unchecked(&self) -> SS
pub fn from_subset(element: &SS) -> SP
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,