Trait graphql_ws_client::websockets::WebsocketMessage

source · 
pub trait WebsocketMessage: Debug {
    type Error: Error + Send + 'static;

    // Required methods
    fn new(text: String) -> Self;
    fn text(&self) -> Option<&str>;
    fn error_message(&self) -> Option<String>;
    fn is_ping(&self) -> bool;
    fn is_pong(&self) -> bool;
    fn is_close(&self) -> bool;
}
👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead
Expand description

An abstraction around WebsocketMessages

graphql-ws-client doesn’t implement the websocket protocol itself. This trait provides part of the integration with websocket client libraries.

Required Associated Types§

source

type Error: Error + Send + 'static

👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead

The Error type for this websocket client.

Required Methods§

source

fn new(text: String) -> Self

👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead

Constructs a new message with the given text

source

fn text(&self) -> Option<&str>

👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead

Returns the text (if there is any) contained in this message

source

fn error_message(&self) -> Option<String>

👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead

Returns the text (if there is any) of the error

source

fn is_ping(&self) -> bool

👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead

Returns true if this message is a websocket ping.

source

fn is_pong(&self) -> bool

👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead

Returns true if this message is a websocket pong.

source

fn is_close(&self) -> bool

👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead

Returns true if this message is a websocket close.

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

source§

impl WebsocketMessage for Message

§

type Error = Error

👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead
source§

fn new(text: String) -> Self

👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead
source§

fn text(&self) -> Option<&str>

👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead
source§

fn error_message(&self) -> Option<String>

👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead
source§

fn is_ping(&self) -> bool

👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead
source§

fn is_pong(&self) -> bool

👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead
source§

fn is_close(&self) -> bool

👎Deprecated since 0.8.0-rc.1: WebsockeMessage is only used for the deprecated AsyncWebsocketClient. You should update to use Client instead

Implementors§