nautilus_binance/websocket/error.rs
1// -------------------------------------------------------------------------------------------------
2// Copyright (C) 2015-2025 Nautech Systems Pty Ltd. All rights reserved.
3// https://nautechsystems.io
4//
5// Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6// You may not use this file except in compliance with the License.
7// You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16//! Binance WebSocket error types.
17
18use std::fmt;
19
20/// Binance WebSocket client error type.
21#[derive(Debug)]
22pub enum BinanceWsError {
23 /// General client error.
24 ClientError(String),
25 /// Authentication failed.
26 AuthenticationError(String),
27 /// Message parsing error.
28 ParseError(String),
29 /// Network or connection error.
30 NetworkError(String),
31 /// Operation timed out.
32 Timeout(String),
33}
34
35impl fmt::Display for BinanceWsError {
36 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
37 match self {
38 Self::ClientError(msg) => write!(f, "Client error: {msg}"),
39 Self::AuthenticationError(msg) => write!(f, "Authentication error: {msg}"),
40 Self::ParseError(msg) => write!(f, "Parse error: {msg}"),
41 Self::NetworkError(msg) => write!(f, "Network error: {msg}"),
42 Self::Timeout(msg) => write!(f, "Timeout: {msg}"),
43 }
44 }
45}
46
47impl std::error::Error for BinanceWsError {}
48
49/// Result type for Binance WebSocket operations.
50pub type BinanceWsResult<T> = Result<T, BinanceWsError>;