Struct websocket_lite::Message

source · [−]

pub struct Message { /* private fields */ }

Expand description

A text string, a block of binary data or a WebSocket control frame.

Implementations

source

impl Message

source

pub fn new(opcode: Opcode, data: B) -> Result<Message, Utf8Error> where
B: Into<Bytes>,

Creates a message from a Bytes object.

The message can be tagged as text or binary. When the opcode parameter is Opcode::Text this function validates the bytes in data and returns Err if they do not contain valid UTF-8 text.

source

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

Creates a text message from a String.

source

pub fn binary(data: B) -> Message where
B: Into<Bytes>,

Creates a binary message from any type that can be converted to Bytes, such as &[u8] or Vec<u8>.

source

pub fn close(reason: Option<(u16, String)>) -> Message

Creates a message that indicates the connection is about to be closed.

The reason parameter is an optional numerical status code and text description. Valid reasons may be defined by a particular WebSocket server.

source

pub fn ping(data: B) -> Message where
B: Into<Bytes>,

Creates a message requesting a pong response.

The client can send one of these to request a pong response from the server.

source

pub fn pong(data: B) -> Message where
B: Into<Bytes>,

Creates a response to a ping message.

The client can send one of these in response to a ping from the server.

source

pub fn opcode(&self) -> Opcode

Returns this message’s WebSocket opcode.

source

pub fn data(&self) -> &Bytes

Returns a reference to the data held in this message.

source

pub fn into_data(self) -> Bytes

Consumes the message, returning its data.

source

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

For messages with opcode Opcode::Text, returns a reference to the text. Returns None otherwise.

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<(), Error>

Formats the value using the given formatter. Read more

source

impl<'a> Encoder<&'a Message> for MessageCodec

type Error = Box<dyn Error + Sync + Send + 'static, Global>

The type of encoding errors. Read more

source

fn encode(
 &mut self,
 item: &Message,
 dst: &mut BytesMut
) -> Result<(), Box<dyn Error + Sync + Send + 'static, Global>>

Encodes a frame into the buffer provided. Read more

source

impl Encoder<Message> for MessageCodec

type Error = Box<dyn Error + Sync + Send + 'static, Global>

The type of encoding errors. Read more

source

fn encode(
 &mut self,
 item: Message,
 dst: &mut BytesMut
) -> Result<(), Box<dyn Error + Sync + Send + 'static, Global>>

Encodes a frame into the buffer provided. Read more

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

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

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

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

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · source

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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

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

Uses borrowed data to replace owned data, usually by cloning. 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

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

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

Performs the conversion.

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

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct websocket_lite::Message

Implementations

impl Message

pub fn new<B>(opcode: Opcode, data: B) -> Result<Message, Utf8Error> where B: Into<Bytes>,

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

pub fn binary<B>(data: B) -> Message where B: Into<Bytes>,

pub fn close(reason: Option<(u16, String)>) -> Message

pub fn ping<B>(data: B) -> Message where B: Into<Bytes>,

pub fn pong<B>(data: B) -> Message where B: Into<Bytes>,

pub fn opcode(&self) -> Opcode

pub fn data(&self) -> &Bytes

pub fn into_data(self) -> Bytes

pub fn as_text(&self) -> Option<&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<(), Error>

impl<'a> Encoder<&'a Message> for MessageCodec

type Error = Box<dyn Error + Sync + Send + 'static, Global>

fn encode( &mut self, item: &Message, dst: &mut BytesMut) -> Result<(), Box<dyn Error + Sync + Send + 'static, Global>>

impl Encoder<Message> for MessageCodec

type Error = Box<dyn Error + Sync + Send + 'static, Global>

fn encode( &mut self, item: Message, dst: &mut BytesMut) -> Result<(), Box<dyn Error + Sync + Send + 'static, Global>>

impl PartialEq<Message> for Message

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

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

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,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn new<B>(opcode: Opcode, data: B) -> Result<Message, Utf8Error> where
B: Into<Bytes>,

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

pub fn binary<B>(data: B) -> Message where
B: Into<Bytes>,

pub fn ping<B>(data: B) -> Message where
B: Into<Bytes>,

pub fn pong<B>(data: B) -> Message where
B: Into<Bytes>,

fn encode(
&mut self,
item: &Message,
dst: &mut BytesMut
) -> Result<(), Box<dyn Error + Sync + Send + 'static, Global>>

fn encode(
&mut self,
item: Message,
dst: &mut BytesMut
) -> Result<(), Box<dyn Error + Sync + Send + 'static, Global>>

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, 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>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,