[−][src]Struct routerify_websocket::Message
A WebSocket message.
Implementations
impl Message
[src]
pub fn text<S: Into<String>>(s: S) -> Message
[src]
Create a new Text
WebSocket message from a stringable.
pub fn json<T: Serialize>(value: &T) -> Result<Message>
[src]
Constructs a Text
WebSocket message with the json value.
Optional
This requires the optional json
feature to be enabled.
pub fn binary<V: Into<Vec<u8>>>(v: V) -> Message
[src]
Create a new Binary
WebSocket message.
pub fn ping<V: Into<Vec<u8>>>(v: V) -> Message
[src]
Construct a new Ping
WebSocket message.
The payload here must have a length less than 125 bytes.
pub fn pong<V: Into<Vec<u8>>>(v: V) -> Message
[src]
Construct a new Pong
WebSocket message.
The payload here must have a length less than 125 bytes.
pub fn close() -> Message
[src]
Construct the default Close
WebSocket message.
pub fn close_with<R: Into<Cow<'static, str>>>(
code: CloseCode,
reason: R
) -> Message
[src]
code: CloseCode,
reason: R
) -> Message
Construct a Close
WebSocket message with a code and reason.
pub fn is_text(&self) -> bool
[src]
Returns true if this message is a Text
message.
pub fn is_binary(&self) -> bool
[src]
Returns true if this message is a Binary
message.
pub fn is_close(&self) -> bool
[src]
Returns true if this message a is a Close
message.
pub fn is_ping(&self) -> bool
[src]
Returns true if this message is a Ping
message.
pub fn is_pong(&self) -> bool
[src]
Returns true if this message is a Pong
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 close_code(&self) -> Option<CloseCode>
[src]
The Close
code if available.
pub fn close_reason(&self) -> Option<&str>
[src]
The Close
reason if available.
pub fn as_text(&self) -> Result<&str>
[src]
Attempts to convert the message data as text in UTF8
format.
pub fn as_bytes(&self) -> &[u8]
[src]
Return the bytes of this message.
pub fn into_bytes(self) -> Vec<u8>
[src]
Consumes the message and returns its data as bytes.
pub fn into_text(self) -> Result<String>
[src]
Consumes the WebSocket message and attempts to converts it to a String
.
pub fn decode_json<T: DeserializeOwned>(self) -> Result<T>
[src]
Try to deserialize the message data as JSON
.
Optional
This requires the optional json
feature to be enabled.
Trait Implementations
impl Clone for Message
[src]
impl Debug for Message
[src]
impl Eq for Message
[src]
impl Into<Vec<u8>> for Message
[src]
impl PartialEq<Message> for Message
[src]
impl Sink<Message> for WebSocket
[src]
type Error = WebsocketError
The type of value produced by the sink when an error occurs.
fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
[src]
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
fn start_send(self: Pin<&mut Self>, item: Message) -> Result<(), Self::Error>
[src]
fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
[src]
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
fn poll_close(
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
[src]
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
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,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
fn equivalent(&self, key: &K) -> bool
[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
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.
fn to_owned(&self) -> T
[src]
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.
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.
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>,