longbridge 4.2.0

Longbridge OpenAPI SDK for Rust
Documentation
use std::fmt::Display;

use longbridge_httpcli::HttpClientError;
use longbridge_wscli::WsClientError;
use time::OffsetDateTime;

/// Longbridge OpenAPI SDK error type
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// Decode Protobuf error
    #[error(transparent)]
    DecodeProtobuf(#[from] prost::DecodeError),

    /// Decode JSON error
    #[error(transparent)]
    DecodeJSON(#[from] serde_json::Error),

    /// Parse field
    #[error("parse field: {name}: {error}")]
    ParseField {
        /// Field name
        name: &'static str,

        /// Error detail
        error: String,
    },

    /// Unknown command
    #[error("unknown command: {0}")]
    UnknownCommand(
        /// Command code
        u8,
    ),

    /// Invalid security symbol
    #[error("invalid security symbol: {symbol}")]
    InvalidSecuritySymbol {
        /// Security symbol
        symbol: String,
    },

    /// Unknown market
    #[error("unknown market: {symbol}")]
    UnknownMarket {
        /// Security symbol
        symbol: String,
    },

    /// Unknown trade session
    #[error("unknown trade session: {symbol}, time={time}")]
    UnknownTradeSession {
        /// Security symbol
        symbol: String,
        /// time
        time: OffsetDateTime,
    },

    /// HTTP client error
    #[error(transparent)]
    HttpClient(#[from] HttpClientError),

    /// Websocket client error
    #[error(transparent)]
    WsClient(#[from] WsClientError),

    /// Blocking error
    #[cfg(feature = "blocking")]
    #[error(transparent)]
    Blocking(#[from] crate::blocking::BlockingError),

    /// OAuth error
    #[error("oauth error: {0}")]
    OAuth(String),
}

impl Error {
    #[inline]
    pub(crate) fn parse_field_error(name: &'static str, error: impl Display) -> Self {
        Self::ParseField {
            name,
            error: error.to_string(),
        }
    }

    /// Returns the OpenAPI error code
    pub fn openapi_error_code(&self) -> Option<i64> {
        match self {
            Error::HttpClient(HttpClientError::OpenApi { code, .. }) => Some(*code as i64),
            Error::WsClient(WsClientError::ResponseError { detail, .. }) => {
                detail.as_ref().map(|detail| detail.code as i64)
            }
            _ => None,
        }
    }

    /// Consumes this error and returns a simple error
    pub fn into_simple_error(self) -> SimpleError {
        match self {
            Error::HttpClient(HttpClientError::OpenApi {
                code,
                message,
                trace_id,
            }) => SimpleError::OpenApi {
                code: code as i64,
                message,
                trace_id,
            },
            Error::HttpClient(HttpClientError::Http(err)) => {
                if let Some(status) = err.0.status() {
                    SimpleError::Http {
                        status_code: status.as_u16(),
                    }
                } else {
                    SimpleError::Other(err.to_string())
                }
            }
            Error::WsClient(WsClientError::ResponseError {
                detail: Some(detail),
                ..
            }) => SimpleError::OpenApi {
                code: detail.code as i64,
                message: detail.msg,
                trace_id: String::new(),
            },
            Error::DecodeProtobuf(_)
            | Error::DecodeJSON(_)
            | Error::InvalidSecuritySymbol { .. }
            | Error::UnknownMarket { .. }
            | Error::UnknownTradeSession { .. }
            | Error::ParseField { .. }
            | Error::UnknownCommand(_)
            | Error::HttpClient(_)
            | Error::WsClient(_) => SimpleError::Other(self.to_string()),
            #[cfg(feature = "blocking")]
            Error::Blocking(_) => SimpleError::Other(self.to_string()),
            Error::OAuth(msg) => SimpleError::OAuth(msg),
        }
    }
}

/// Longbridge OpenAPI SDK result type
pub type Result<T> = ::std::result::Result<T, Error>;

/// Simple error type
#[derive(Debug, thiserror::Error)]
pub enum SimpleError {
    /// Http error
    #[error("http error: status_code={status_code}")]
    Http {
        /// HTTP status code
        status_code: u16,
    },
    /// OpenAPI error
    #[error("openapi error: code={code} message={message}")]
    OpenApi {
        /// Error code
        code: i64,
        /// Error message
        message: String,
        /// Trace id
        trace_id: String,
    },
    /// Other error
    #[error("other error: {0}")]
    Other(String),
    /// OAuth error
    #[error("oauth error: {0}")]
    OAuth(String),
}

impl From<Error> for SimpleError {
    #[inline]
    fn from(err: Error) -> Self {
        err.into_simple_error()
    }
}

/// Simple error kind
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum SimpleErrorKind {
    /// HTTP error
    Http,
    /// OpenAPI error
    OpenApi,
    /// Other error
    Other,
    /// OAuth error
    OAuth,
}

impl SimpleError {
    /// Returns the kind of this error
    pub fn kind(&self) -> SimpleErrorKind {
        match self {
            SimpleError::Http { .. } => SimpleErrorKind::Http,
            SimpleError::OpenApi { .. } => SimpleErrorKind::OpenApi,
            SimpleError::Other(_) => SimpleErrorKind::Other,
            SimpleError::OAuth(_) => SimpleErrorKind::OAuth,
        }
    }

    /// Returns the error code
    pub fn code(&self) -> Option<i64> {
        match self {
            SimpleError::Http { status_code } => Some(*status_code as i64),
            SimpleError::OpenApi { code, .. } => Some(*code),
            SimpleError::Other(_) => None,
            SimpleError::OAuth(_) => None,
        }
    }

    /// Returns the trace id
    pub fn trace_id(&self) -> Option<&str> {
        match self {
            SimpleError::Http { .. } => None,
            SimpleError::OpenApi { trace_id, .. } => Some(trace_id),
            SimpleError::Other(_) => None,
            SimpleError::OAuth(_) => None,
        }
    }

    /// Returns the error message
    pub fn message(&self) -> &str {
        match self {
            SimpleError::Http { .. } => "bad status code",
            SimpleError::OpenApi { message, .. } => message.as_str(),
            SimpleError::Other(message) => message.as_str(),
            SimpleError::OAuth(message) => message.as_str(),
        }
    }
}