Enum Message 

pub enum Message {
    Text(Bytes),
    Binary(Bytes),
    Ping(Bytes),
    Pong(Bytes),
    Close(Option<CloseFrame>),
}

A WebSocket message.

Backend-agnostic representation handed to consumers of the nautilus-network transport layer. Each backend provides From impls between its native Message type and this enum.

Text is documented to carry UTF-8 by contract but the type does not enforce it. Backends that already validate (such as tokio-tungstenite) produce valid bytes; an in-house HFT backend may skip validation for performance and rely on the consumer’s parser to catch malformed bytes. Use Self::as_text to view the payload as &str.

Variants

Text(Bytes)

Text message. Payload is UTF-8 by contract, not by type guarantee.

Binary(Bytes)

Binary message.

Ping(Bytes)

Ping control frame. Payload bounded to 125 bytes by RFC 6455.

Pong(Bytes)

Pong control frame. Payload bounded to 125 bytes by RFC 6455.

Close(Option<CloseFrame>)

Close control frame with optional close frame payload.

Implementations

impl Message

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

Construct a text message from any string-like value.

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

Borrow a text message as &str if the payload is valid UTF-8.

Validates on each call; for hot paths where the producer is trusted, callers can read the bytes directly via Self::as_bytes and feed them to a parser that catches malformed input.

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

Construct a binary message.

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

Construct a ping message.

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

Construct a pong message.

pub const fn is_text(&self) -> bool

Returns true for text messages.

pub const fn is_binary(&self) -> bool

Returns true for binary messages.

pub const fn is_ping(&self) -> bool

Returns true for ping messages.

pub const fn is_pong(&self) -> bool

Returns true for pong messages.

pub const fn is_close(&self) -> bool

Returns true for close messages.

pub const fn is_control(&self) -> bool

Returns true for control frames (ping, pong, close).

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

Returns the message payload as a byte slice.

For close frames, returns the reason payload as bytes.

pub fn into_bytes(self) -> Bytes

Consumes the message and returns its payload as Bytes.

For close frames, returns an empty Bytes.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl From<&str> for Message

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Bytes> for Message

fn from(b: Bytes) -> Self

Converts to this type from the input type.

impl From<Message> for Message

fn from(value: Message) -> Self

Converts to this type from the input type.

impl From<Message> for Message

fn from(value: SockudoMessage) -> Self

Converts to this type from the input type.

impl From<Message> for Message

fn from(value: Message) -> Self

Convert a neutral Message into a sockudo [SockudoMessage].

Conversion is infallible: both enums carry payloads as bytes::Bytes across all variants. Sockudo validates UTF-8 on Text frames at parse time, not at send time, so feeding it non-UTF-8 bytes via [Self::Text] is the caller’s responsibility.

impl From<String> for Message

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Message

fn from(v: Vec<u8>) -> Self

Converts to this type from the input type.

impl PartialEq for Message

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S> Sink<Message> for SockudoTransport<S>

where S: AsyncRead + AsyncWrite + Unpin,

type Error = TransportError

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

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

Attempts to prepare the Sink to receive a value.

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(())).

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

Flush any remaining output from this sink.

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

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

impl<S> Sink<Message> for TungsteniteTransport<S>

where S: AsyncRead + AsyncWrite + Unpin,

type Error = TransportError

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

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

Attempts to prepare the Sink to receive a value.

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(())).

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

Flush any remaining output from this sink.

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

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

impl TryFrom<Message> for Message

fn try_from(value: Message) -> Result<Self, Self::Error>

Convert a neutral Message into a tungstenite [tungstenite::Message].

Validates the Text payload as UTF-8 because tungstenite refuses to transmit a Text frame whose body is not valid UTF-8. Other variants are infallible.

Errors

Returns TransportError::InvalidUtf8 if a Text payload is not valid UTF-8.

type Error = TransportError

The type returned in the event of a conversion error.

impl Eq for Message

impl StructuralPartialEq for Message