binance-sdk 45.0.0

This is a lightweight library that works as a connector to the Binance public API.
use derive_builder::UninitializedFieldError;
use serde::de::DeserializeOwned;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::fmt;
use std::marker::PhantomData;
use std::{collections::HashMap, future::Future, pin::Pin};
use thiserror::Error;

use super::errors::ConnectorError;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TimeUnit {
    Millisecond,
    Microsecond,
}

impl fmt::Display for TimeUnit {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            TimeUnit::Millisecond => write!(f, "millisecond"),
            TimeUnit::Microsecond => write!(f, "microsecond"),
        }
    }
}

impl TimeUnit {
    #[must_use]
    pub fn as_upper_str(&self) -> &'static str {
        match self {
            TimeUnit::Millisecond => "MILLISECOND",
            TimeUnit::Microsecond => "MICROSECOND",
        }
    }
    #[must_use]
    pub fn as_lower_str(&self) -> &'static str {
        match self {
            TimeUnit::Millisecond => "millisecond",
            TimeUnit::Microsecond => "microsecond",
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
pub enum RateLimitType {
    RequestWeight,
    Orders,
    RawRequests,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
pub enum Interval {
    Second,
    Minute,
    Hour,
    Day,
}

#[derive(Debug, Clone)]
pub struct RestApiRateLimit {
    pub rate_limit_type: RateLimitType,
    pub interval: Interval,
    pub interval_num: u32,
    pub count: u32,
    pub retry_after: Option<u32>,
}

pub type DataFuture<T> = Pin<Box<dyn Future<Output = T> + Send>>;

pub struct RestApiResponse<T> {
    pub(crate) data_fn: Box<
        dyn FnOnce() -> Pin<Box<dyn Future<Output = Result<T, ConnectorError>> + Send>>
            + Send
            + Sync,
    >,
    pub status: u16,
    pub headers: HashMap<String, String>,
    pub rate_limits: Option<Vec<RestApiRateLimit>>,
}

impl<T> RestApiResponse<T>
where
    T: Send + 'static,
{
    /// Executes the data retrieval function and returns the result.
    ///
    /// # Returns
    ///
    /// A `Result` containing the data of type `T` if successful,
    /// or a `ConnectorError` if the operation fails.
    ///
    /// # Errors
    ///
    /// Returns an error if the operation fails.
    ///
    /// # Examples
    ///
    ///
    /// let response: `RestApiResponse`<MyType> = ...;
    /// let data = response.data().await?;
    ///
    pub async fn data(self) -> Result<T, ConnectorError> {
        (self.data_fn)().await
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct WebsocketApiRateLimit {
    #[serde(rename = "rateLimitType")]
    pub rate_limit_type: RateLimitType,
    #[serde(rename = "interval")]
    pub interval: Interval,
    #[serde(rename = "intervalNum")]
    pub interval_num: u32,
    pub limit: u32,
    #[serde(default)]
    pub count: u32,
}

#[derive(Debug)]
pub struct WebsocketApiResponse<T> {
    pub(crate) _marker: PhantomData<T>,

    pub raw: Value,
    pub rate_limits: Option<Vec<WebsocketApiRateLimit>>,
}

impl<T> WebsocketApiResponse<T>
where
    T: DeserializeOwned,
{
    /// Deserializes the raw JSON value into the generic type `T`.
    ///
    /// # Returns
    ///
    /// A `Result` containing the deserialized value of type `T` if successful,
    /// or a `serde_json::Error` if deserialization fails.
    ///
    /// # Errors
    ///
    /// Returns an error if deserialization fails.
    ///
    /// # Examples
    ///
    ///
    /// // Assuming `WebsocketApiResponse` contains a raw JSON value
    /// let response: `WebsocketApiResponse`<MyType> = ...;
    /// let data = `response.data()`?;
    ///
    pub fn data(self) -> serde_json::Result<T> {
        serde_json::from_value(self.raw)
    }
}

#[derive(Debug, Error)]
pub enum ParamBuildError {
    #[error("missing required field `{0}`")]
    UninitializedField(&'static str),
}

impl From<UninitializedFieldError> for ParamBuildError {
    fn from(err: UninitializedFieldError) -> Self {
        ParamBuildError::UninitializedField(err.field_name())
    }
}

#[derive(Debug, Error)]
pub enum ConfigBuildError {
    #[error("Configuration missing or invalid `{0}`")]
    UninitializedField(&'static str),
}

impl From<UninitializedFieldError> for ConfigBuildError {
    fn from(err: UninitializedFieldError) -> Self {
        ConfigBuildError::UninitializedField(err.field_name())
    }
}

#[derive(Debug, Clone, PartialEq)]
pub enum WebsocketEvent {
    Open,
    Message(String),
    Error(String),
    Close(u16, String),
    Ping,
    Pong,
}

#[derive(Debug, Clone, PartialEq)]
pub enum WebsocketMode {
    Single,
    Pool(usize),
}

impl WebsocketMode {
    #[must_use]
    pub fn pool_size(&self) -> usize {
        match *self {
            WebsocketMode::Single => 1,
            WebsocketMode::Pool(sz) => sz,
        }
    }
}

#[derive(Debug, Clone, Default)]
pub struct WebsocketApiConnectConfig {
    pub mode: Option<WebsocketMode>,
}

#[derive(Debug, Clone, Default)]
pub struct WebsocketStreamsConnectConfig {
    pub streams: Vec<String>,
    pub mode: Option<WebsocketMode>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum StreamId {
    Str(String),
    Number(u32),
}

impl From<String> for StreamId {
    fn from(v: String) -> Self {
        StreamId::Str(v)
    }
}
impl From<u32> for StreamId {
    fn from(v: u32) -> Self {
        StreamId::Number(v)
    }
}