Enum poem::web::websocket::Message

source · [−]

pub enum Message {
    Text(String),
    Binary(Vec<u8>),
    Ping(Vec<u8>),
    Pong(Vec<u8>),
    Close(Option<(CloseCode, String)>),
}

Available on crate feature websocket only.

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

`Ping(Vec<u8>)`

A ping message with the specified payload

The payload here must have a length less than 125 bytes

`Pong(Vec<u8>)`

A pong message with the specified payload

The payload here must have a length less than 125 bytes

`Close(Option<(CloseCode, String)>)`

A close message with the optional close frame.

Implementations

source

impl Message

source

pub fn text(text: impl Into<String>) -> Self

Construct a new text message.

source

pub fn binary(data: impl Into<Vec<u8>>) -> Self

Construct a new binary message.

source

pub fn ping(data: impl Into<Vec<u8>>) -> Self

Construct a new ping message.

source

pub fn pong(data: impl Into<Vec<u8>>) -> Self

Construct a new pong message.

source

pub fn close() -> Self

Construct the default close message.

source

pub fn close_with(code: impl Into<CloseCode>, reason: impl Into<String>) -> Self

Construct a close message with a code and reason.

source

pub fn is_text(&self) -> bool

Returns true if this message is a Text message.

source

pub fn is_binary(&self) -> bool

Returns true if this message is a Binary message.

source

pub fn is_ping(&self) -> bool

Returns true if this message is a Ping message.

source

pub fn is_pong(&self) -> bool

Returns true if this message is a Pong message.

source

pub fn is_close(&self) -> bool

Returns true if this message a is a Close message.

source

pub fn into_bytes(self) -> Vec<u8>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

Destructure this message into binary data.

source

pub fn as_bytes(&self) -> &[u8]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

Return the bytes of this message, if the message can contain data.

Trait Implementations

source

impl Clone for Message

source

fn clone(&self) -> Message

Returns a copy of the value. Read more

1.0.0 · source

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl Sink<Message> for WebSocketStream

type Error = Error

The type of value produced by the sink when an error occurs.

source

fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value. Read more

source

fn start_send(self: Pin<&mut Self>, item: Message) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())). Read more

source

fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink. Read more

source

fn poll_close(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary. Read more

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 Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AnyEq for Twhere
T: Any + PartialEq<T>,

fn equals(&self, other: &(dyn Any + 'static)) -> bool

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

impl<'a, T> AsTaggedExplicit<'a> for Twhere
T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self>

impl<'a, T> AsTaggedImplicit<'a> for Twhere
T: 'a,

fn implicit(
 self,
 class: Class,
 constructed: bool,
 tag: u32
) -> TaggedParser<'a, Implicit, Self>

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> FutureExt for T

source

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

source

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

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 Twhere
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> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for Twhere
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 Twhere
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 Twhere
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 Twhere
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

Enum poem::web::websocket::Message

Variants

Text(String)

Binary(Vec<u8>)

Ping(Vec<u8>)

Pong(Vec<u8>)

Close(Option<(CloseCode, String)>)

Implementations

impl Message

pub fn text(text: impl Into<String>) -> Self

pub fn binary(data: impl Into<Vec<u8>>) -> Self

pub fn ping(data: impl Into<Vec<u8>>) -> Self

pub fn pong(data: impl Into<Vec<u8>>) -> Self

pub fn close() -> Self

pub fn close_with(code: impl Into<CloseCode>, reason: impl Into<String>) -> Self

pub fn is_text(&self) -> bool

pub fn is_binary(&self) -> bool

pub fn is_ping(&self) -> bool

pub fn is_pong(&self) -> bool

pub fn is_close(&self) -> bool

pub fn into_bytes(self) -> Vec<u8>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where A: Allocator,

pub fn as_bytes(&self) -> &[u8]ⓘNotable traits for &[u8]impl Read for &[u8]impl Write for &mut [u8]

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

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

impl Debug for Message

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

impl PartialEq<Message> for Message

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

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

impl Sink<Message> for WebSocketStream

type Error = Error

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

fn start_send(self: Pin<&mut Self>, item: Message) -> Result<(), Self::Error>

fn poll_flush( 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>>

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 Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> AnyEq for Twhere T: Any + PartialEq<T>,

fn equals(&self, other: &(dyn Any + 'static)) -> bool

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

impl<'a, T> AsTaggedExplicit<'a> for Twhere T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self>

impl<'a, T> AsTaggedImplicit<'a> for Twhere T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32) -> TaggedParser<'a, Implicit, Self>

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

fn borrow(&self) -> &T

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

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

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

fn with_current_context(self) -> WithContext<Self>

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 Twhere U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

`Text(String)`

`Binary(Vec<u8>)`

`Ping(Vec<u8>)`

`Pong(Vec<u8>)`

`Close(Option<(CloseCode, String)>)`

pub fn into_bytes(self) -> Vec<u8>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

pub fn as_bytes(&self) -> &[u8]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

fn poll_flush(
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>>

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

impl<T> AnyEq for Twhere
T: Any + PartialEq<T>,

impl<'a, T> AsTaggedExplicit<'a> for Twhere
T: 'a,

impl<'a, T> AsTaggedImplicit<'a> for Twhere
T: 'a,

fn implicit(
self,
class: Class,
constructed: bool,
tag: u32
) -> TaggedParser<'a, Implicit, Self>

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

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

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

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

impl<T> ToOwned for Twhere
T: Clone,

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

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

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

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