Enum web_socket::Event

pub enum Event<'a> {
    Ping(&'a [u8]),
    Pong(&'a [u8]),
}

Represent a websocket event, either Ping or Pong

Variants

Ping(&'a [u8])

A Ping frame may serve either as a keepalive or as a means to verify that the remote endpoint is still responsive.

Pong(&'a [u8])

A Pong frame sent in response to a Ping frame must have identical “Application data” as found in the message body of the Ping frame being replied to.

A Pong frame MAY be sent unsolicited. This serves as a unidirectional heartbeat. A response to an unsolicited Pong frame is not expected.

Implementations

impl Event<'_>

pub const fn data(&self) -> &[u8]

Returns the slice of data contained within a Ping or Pong frame.

Trait Implementations

impl<'a> Clone for Event<'a>

fn clone(&self) -> Event<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Event<'a>

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

Formats the value using the given formatter.

impl Display for Event<'_>

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

Formats the value using the given formatter.

impl Message for Event<'_>

fn encode<const SIDE: bool>(&self, writer: &mut Vec<u8>)

Encode websocket data frame.