[−][src]Struct salvo_extra::ws::Message
A WebSocket message.
This will likely become a non-exhaustive
enum in the future, once that
language feature has stabilized.
Implementations
impl Message
[src]
pub fn text<S: Into<String>>(s: S) -> Message
[src]
Construct a new Text Message
.
pub fn binary<V: Into<Vec<u8>>>(v: V) -> Message
[src]
Construct a new Binary Message
.
pub fn ping<V: Into<Vec<u8>>>(v: V) -> Message
[src]
Construct a new Ping Message
.
pub fn close() -> Message
[src]
Construct the default Close Message
.
pub fn close_with(
code: impl Into<u16>,
reason: impl Into<Cow<'static, str>>
) -> Message
[src]
code: impl Into<u16>,
reason: impl Into<Cow<'static, str>>
) -> Message
Construct a Close 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 close_frame(&self) -> Option<(u16, &str)>
[src]
Try to get the close frame (close code and reason)
pub fn to_str(&self) -> Result<&str, ()>
[src]
Try to get a reference to the string text, if this is a Text message.
pub fn as_bytes(&self) -> &[u8]
[src]
Return the bytes of this message, if the message can contain data.
pub fn into_bytes(self) -> Vec<u8>
[src]
Destructure this message into binary data.
Trait Implementations
impl Clone for Message
[src]
impl Debug for Message
[src]
impl Eq for Message
[src]
impl Into<Vec<u8, Global>> for Message
[src]
impl PartialEq<Message> for Message
[src]
impl Sink<Message> for WebSocket
[src]
type Error = Error
The type of value produced by the sink when an error occurs.
pub fn poll_ready(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
[src]
mut self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
pub fn start_send(
mut self: Pin<&mut Self>,
item: Message
) -> Result<(), Self::Error>
[src]
mut self: Pin<&mut Self>,
item: Message
) -> Result<(), Self::Error>
pub fn poll_flush(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
[src]
mut self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
pub fn poll_close(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
[src]
mut 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
[src]
impl Send for Message
[src]
impl Sync for Message
[src]
impl Unpin for Message
[src]
impl UnwindSafe for Message
[src]
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<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
pub fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[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.
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>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,