Enum parity_ws::Message

source · [−]

pub enum Message {
    Text(String),
    Binary(Vec<u8>),
}

Expand description

An enum representing the various forms of a WebSocket message.

Variants

`Text(String)`

A text WebSocket message

`Binary(Vec<u8>)`

A binary WebSocket message

Implementations

source

impl Message

source

pub fn text<S>(string: S) -> Message where
S: Into<String>,

Create a new text WebSocket message from a stringable.

source

pub fn binary(bin: B) -> Message where
B: Into<Vec<u8>>,

Create a new binary WebSocket message by converting to Vec.

source

pub fn is_text(&self) -> bool

Indicates whether a message is a text message.

source

pub fn is_binary(&self) -> bool

Indicates whether a message is a binary message.

source

pub fn len(&self) -> usize

Get the length of the WebSocket message.

source

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.

source

pub fn into_data(self) -> Vec<u8>

Consume the WebSocket and return it as binary data.

source

pub fn into_text(self) -> Result<String>

Attempt to consume the WebSocket message and convert it to a String.

source

pub fn as_text(&self) -> Result<&str>

Attempt to get a &str from the WebSocket message, this will try to convert binary data to utf8.

Trait Implementations

source

impl Clone for Message

source

fn clone(&self) -> Message

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl Debug for Message

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

impl Display for Message

source

fn fmt(&self, f: &mut Formatter<'_>) -> StdResult<(), Error>

Formats the value using the given formatter. Read more

source

impl<'b> From<&'b [u8 ]> for Message

source

fn from(data: &'b [u8 ]) -> Message

Performs the conversion.

source

impl<'s> From<&'s str> for Message

source

fn from(string: &'s str) -> Message

Performs the conversion.

source

impl From<String> for Message

source

fn from(string: String) -> Message

Performs the conversion.

source

impl From<Vec<u8, Global>> for Message

source

fn from(data: Vec<u8>) -> Message

Performs the conversion.

source

impl PartialEq<Message> for Message

source

fn eq(&self, other: &Message) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &Message) -> bool

This method tests for !=.

source

impl Eq for Message

source

impl StructuralEq for Message

source

impl StructuralPartialEq for Message

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

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

source

Enum parity_ws::Message

Variants

Text(String)

Binary(Vec<u8>)

Implementations

impl Message

pub fn text<S>(string: S) -> Message where S: Into<String>,

pub fn binary<B>(bin: B) -> Message where B: Into<Vec<u8>>,

pub fn is_text(&self) -> bool

pub fn is_binary(&self) -> bool

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn into_data(self) -> Vec<u8>

pub fn into_text(self) -> Result<String>

pub fn as_text(&self) -> Result<&str>

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

fn clone_from(&mut self, source: &Self)

impl Debug for Message

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Display for Message

fn fmt(&self, f: &mut Formatter<'_>) -> StdResult<(), Error>

impl<'b> From<&'b [u8]> for Message

fn from(data: &'b [u8]) -> Message

impl<'s> From<&'s str> for Message

fn from(string: &'s str) -> Message

impl From<String> for Message

fn from(string: String) -> Message

impl From<Vec<u8, Global>> for Message

fn from(data: Vec<u8>) -> Message

impl PartialEq<Message> for Message

fn eq(&self, other: &Message) -> bool

fn ne(&self, other: &Message) -> bool

impl Eq for Message

impl StructuralEq for Message

impl StructuralPartialEq for Message

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,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

pub default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

`Text(String)`

`Binary(Vec<u8>)`

pub fn text<S>(string: S) -> Message where
S: Into<String>,

pub fn binary<B>(bin: B) -> Message where
B: Into<Vec<u8>>,

impl<'b> From<&'b [u8 ]> for Message

fn from(data: &'b [u8 ]) -> Message

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,