e-imzo 0.4.0

E-IMZO SDK for easier accessing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

use native_tls::TlsStream;
use std::io;
use std::net::TcpStream;
use thiserror::Error;
use tungstenite::ClientHandshake;

/// Result type for this crate's use.
///
/// Instead of using Rust's defaulted Result type, we abstracted
/// Result type to accept a single type parameter by defaulting
/// our error type
pub type Result<T, E = EIMZOError> = std::result::Result<T, E>;

/// E-IMZO crate's error type collection.
#[derive(Error, Debug)]
pub enum EIMZOError {
    #[error("A websocket server went down: {0}")]
    Io(#[from] io::Error),
    #[error("JsonParse error: {0}")]
    JsonParse(#[from] serde_json::Error),
    #[error("UrlParseError  error: {0}")]
    UrlParseError(#[from] url::ParseError),
    // native_tls
    #[error("TlsError  error: {0}")]
    TlsError(#[from] native_tls::Error),
    #[error("TlsHandshakeError  error: {0}")]
    TlsHandshakeError(#[from] native_tls::HandshakeError<TcpStream>),
    #[error("HandshakeError error: {0}")]
    HandshakeError(#[from] tungstenite::HandshakeError<ClientHandshake<TlsStream<TcpStream>>>),

    #[error("Websocket error: {0}")]
    Websocket(#[from] tungstenite::Error),
    #[error(
        "Server closed the connection. Maybe reconnect again with `EIMZO::new()`,
      {0:?}"
    )]
    WebsocketClosed(Option<tungstenite::protocol::CloseFrame>),
    #[error(
        "Return type is not tungstenite::Message, it's something Binary or Frame.
      Other Text, Close, Ping, Pong cases handled on client.rs
      {0:?}"
    )]
    NotTextWebsocketMessage(tungstenite::Message),

    #[error("Error while changing SDK language {0}")]
    LocaleError(#[from] locale_rs::error::LocaleError),

    /// To be used only if you get despaired.
    #[error("Something aggressive is going on")]
    Unknown,
}