Enum tungstenite::protocol::Message [−][src]
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
[src]
pub fn text<S>(string: S) -> Message where
S: Into<String>,
[src]
S: Into<String>,
Create a new text WebSocket message from a stringable.
pub fn binary<B>(bin: B) -> Message where
B: Into<Vec<u8>>,
[src]
B: Into<Vec<u8>>,
Create a new binary WebSocket message by converting to Vec
pub fn is_text(&self) -> bool
[src]
Indicates whether a message is a text message.
pub fn is_binary(&self) -> bool
[src]
Indicates whether a message is a binary message.
pub fn is_ping(&self) -> bool
[src]
Indicates whether a message is a ping message.
pub fn is_pong(&self) -> bool
[src]
Indicates whether a message is a pong message.
pub fn is_close(&self) -> bool
[src]
Indicates whether a message ia s close message.
pub fn len(&self) -> usize
[src]
Get the length of the WebSocket message.
pub fn is_empty(&self) -> bool
[src]
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>
[src]
Consume the WebSocket and return it as binary data.
pub fn into_text(self) -> Result<String>
[src]
Attempt to consume the WebSocket message and convert it to a String.
pub fn to_text(&self) -> Result<&str>
[src]
Attempt to get a &str from the WebSocket message, this will try to convert binary data to utf8.
Trait Implementations
impl Clone for Message
[src]
impl Debug for Message
[src]
impl Display for Message
[src]
impl Eq for Message
[src]
impl<'b> From<&'b [u8]> for Message
[src]
impl<'s> From<&'s str> for Message
[src]
impl From<String> for Message
[src]
impl From<Vec<u8, Global>> for Message
[src]
impl Into<Vec<u8, Global>> for Message
[src]
impl PartialEq<Message> for Message
[src]
impl StructuralEq 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> Same<T> for T
[src]
type Output = T
Should always be Self
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> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
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>,
[src]
V: MultiLane<T>,