Enum BinanceWsError 

#[non_exhaustive]
pub enum BinanceWsError {
    MissingStream {
        raw: String,
    },
    UnsupportedEvent {
        event: String,
    },
    SubscriptionFailed {
        stream: String,
        reason: String,
    },
    Connection(String),
    Core(Error),
}

Binance WebSocket specific errors.

Implements StdError + Send + Sync for use with CoreError::WebSocket. Uses #[non_exhaustive] to allow adding variants in future versions.

Variants

• MissingStream: Stream name missing in WebSocket message
• UnsupportedEvent: Received an unsupported event type
• SubscriptionFailed: Stream subscription failed
• Connection: WebSocket connection error
• Core: Passthrough for core errors

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MissingStream

Stream name missing in message.

This occurs when a WebSocket message doesn’t contain the expected stream identifier, making it impossible to route the message.

Fields

raw: String

The raw message content (truncated for display)

UnsupportedEvent

Unsupported event type.

This occurs when the WebSocket receives an event type that is not handled by the current implementation.

Fields

event: String

The event type that was not recognized

SubscriptionFailed

Subscription failed.

This occurs when a stream subscription request is rejected by the Binance WebSocket server.

Fields

stream: String

The stream name that failed to subscribe

reason: String

The reason for the failure

Connection(String)

WebSocket connection error.

General connection-related errors that don’t fit other categories.

Core(Error)

Core error passthrough.

Allows wrapping core errors within Binance-specific error handling while maintaining the ability to extract the original error.

Implementations

impl BinanceWsError

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

Creates a new MissingStream error.

Arguments

• raw - The raw message content (will be truncated if too long)

Example

use ccxt_exchanges::binance::error::BinanceWsError;

let err = BinanceWsError::missing_stream(r#"{"data": "unknown"}"#);

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

Creates a new UnsupportedEvent error.

Arguments

• event - The unsupported event type

Example

use ccxt_exchanges::binance::error::BinanceWsError;

let err = BinanceWsError::unsupported_event("unknownEvent");

pub fn subscription_failed( stream: impl Into<String>, reason: impl Into<String>, ) -> Self

Creates a new SubscriptionFailed error.

Arguments

• stream - The stream name that failed
• reason - The reason for the failure

Example

use ccxt_exchanges::binance::error::BinanceWsError;

let err = BinanceWsError::subscription_failed("btcusdt@ticker", "Invalid symbol");

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

Creates a new Connection error.

Arguments

• message - The connection error message

Example

use ccxt_exchanges::binance::error::BinanceWsError;

let err = BinanceWsError::connection("Failed to establish connection");

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

Returns the stream name if this error is related to a specific stream.

Returns

• Some(&str) - The stream name for SubscriptionFailed variant
• None - For all other variants

Example

use ccxt_exchanges::binance::error::BinanceWsError;

let err = BinanceWsError::subscription_failed("btcusdt@ticker", "Invalid");
assert_eq!(err.stream_name(), Some("btcusdt@ticker"));

let err = BinanceWsError::connection("Failed");
assert_eq!(err.stream_name(), None);

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

Returns the event type if this is an UnsupportedEvent error.

Returns

• Some(&str) - The event type for UnsupportedEvent variant
• None - For all other variants

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

Returns the raw message if this is a MissingStream error.

Returns

• Some(&str) - The raw message for MissingStream variant
• None - For all other variants

Trait Implementations

impl Debug for BinanceWsError

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

Formats the value using the given formatter.

impl Display for BinanceWsError

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

Formats the value using the given formatter.

impl Error for BinanceWsError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<BinanceWsError> for Error

Conversion from BinanceWsError to CoreError.

This implementation allows Binance-specific errors to be returned from public API methods that return CoreError. The conversion preserves the original error for downcast capability.

Conversion Rules

• BinanceWsError::Core(core) → Returns the inner CoreError directly
• All other variants → Boxed into CoreError::WebSocket for downcast

fn from(e: BinanceWsError) -> Self

Converts to this type from the input type.

impl From<Error> for BinanceWsError

fn from(source: CoreError) -> Self

Converts to this type from the input type.