Struct wicrs_server::websocket::WebSocketMessage[−][src]

pub struct WebSocketMessage { /* fields omitted */ }

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>(s: S) -> Message where S: Into<String>,` [src]

Construct a new Text Message.

`pub fn binary<V>(v: V) -> Message where V: Into<Vec<u8, Global>>,` [src]

Construct a new Binary Message.

`pub fn ping<V>(v: V) -> Message where V: Into<Vec<u8, Global>>,` [src]

Construct a new Ping Message.

`pub fn pong<V>(v: V) -> Message where V: Into<Vec<u8, Global>>,` [src]

Construct a new Pong Message.

Note that one rarely needs to manually construct a Pong message because the underlying tungstenite socket automatically responds to the Ping messages it receives. Manual construction might still be useful in some cases like in tests or to send unidirectional heartbeats.

`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]

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, Global>`[src]

Destructure this message into binary data.

Trait Implementations

`impl Clone for Message`[src]

`pub fn clone(&self) -> Message`[src]

`pub fn clone_from(&mut self, source: &Self)`1.0.0 [src]

`impl Debug for Message`[src]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

`impl Eq for Message`[src]

`impl Into<Vec<u8, Global>> for Message`[src]

`pub fn into(self) -> Vec<u8, Global>`[src]

`impl PartialEq<Message> for Message`[src]

`pub fn eq(&self, other: &Message) -> bool`[src]

`pub fn ne(&self, other: &Message) -> bool`[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]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Downcast for T where T: Any,`

`pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>`

`pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>`

`pub fn as_any(&self) -> &(dyn Any + 'static)`

`pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)`

`impl<T> DowncastSync for T where T: Any + Send + Sync,`

`pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Sync + Send>`

`impl<Q, K> Equivalent<K> for Q where K: Borrow<Q> + ?Sized, Q: Eq + ?Sized,` [src]

`pub fn equivalent(&self, key: &K) -> bool`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T> Fruit for T where T: Send + Downcast,` [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 for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T> IntoResult<T> for T`[src]

`type Err = Infallible`

`pub fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>`[src]

`impl<T> Pointable for T`

`pub const ALIGN: usize`

`type Init = T`

The type for initializers.

`pub unsafe fn init(init: <T as Pointable>::Init) -> usize`

`pub unsafe fn deref<'a>(ptr: usize) -> &'a T`

`pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T`

`pub unsafe fn drop(ptr: usize)`

`impl<T> Same<T> for T`

`type Output = T`

Should always be Self

`impl<T> ToOwned for T where T: Clone,` [src]

`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 for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

Struct wicrs_server::websocket::WebSocketMessage⎘[−][src]

Implementations

impl Message[src]

pub fn text<S>(s: S) -> Message where S: Into<String>, [src]

pub fn binary<V>(v: V) -> Message where V: Into<Vec<u8, Global>>, [src]

pub fn ping<V>(v: V) -> Message where V: Into<Vec<u8, Global>>, [src]

pub fn pong<V>(v: V) -> Message where V: Into<Vec<u8, Global>>, [src]

pub fn close() -> Message[src]

pub fn close_with( code: impl Into<u16>, reason: impl Into<Cow<'static, str>>) -> Message[src]

pub fn is_text(&self) -> bool[src]

pub fn is_binary(&self) -> bool[src]

pub fn is_close(&self) -> bool[src]

pub fn is_ping(&self) -> bool[src]

pub fn is_pong(&self) -> bool[src]

pub fn close_frame(&self) -> Option<(u16, &str)>[src]

pub fn to_str(&self) -> Result<&str, ()>[src]

pub fn as_bytes(&self) -> &[u8][src]

pub fn into_bytes(self) -> Vec<u8, Global>[src]

Trait Implementations

impl Clone for Message[src]

pub fn clone(&self) -> Message[src]

pub fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for Message[src]

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

impl Eq for Message[src]

impl Into<Vec<u8, Global>> for Message[src]

pub fn into(self) -> Vec<u8, Global>[src]

impl PartialEq<Message> for Message[src]

pub fn eq(&self, other: &Message) -> bool[src]

pub fn ne(&self, other: &Message) -> bool[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]

pub fn type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

impl<T> Downcast for T where T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

pub fn as_any(&self) -> &(dyn Any + 'static)

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for T where T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Sync + Send>

impl<Q, K> Equivalent<K> for Q where K: Borrow<Q> + ?Sized, Q: Eq + ?Sized, [src]

pub fn equivalent(&self, key: &K) -> bool[src]

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

impl<T> Fruit for T where T: Send + Downcast, [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]

pub fn into(self) -> U[src]

impl<T> IntoResult<T> for T[src]

type Err = Infallible

pub fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>[src]

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

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]

type Error = Infallible