bat-markets-core 0.3.4

Core domain contracts and in-memory state engine for bat-markets
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

use serde::{Deserialize, Serialize};
use thiserror::Error;

use crate::ids::RequestId;
use crate::types::{Product, Venue};

/// Stable machine-handleable error classes.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ErrorKind {
    ConfigError,
    TransportError,
    Timeout,
    RateLimited,
    AuthError,
    PermissionDenied,
    Unsupported,
    DecodeError,
    ExchangeReject,
    UnknownExecution,
    StateDivergence,
    ComplianceRequired,
    TemporaryUnavailable,
}

/// Safe structured context for an error.
#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct ErrorContext {
    pub venue: Option<Venue>,
    pub product: Option<Product>,
    pub operation: Option<Box<str>>,
    pub request_id: Option<RequestId>,
    pub native_code: Option<Box<str>>,
    pub retriable: bool,
}

/// Canonical error type used across the engine.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Error)]
#[error("{kind:?}: {message}")]
pub struct MarketError {
    pub kind: ErrorKind,
    pub message: Box<str>,
    pub context: ErrorContext,
}

/// Canonical result type.
pub type Result<T> = core::result::Result<T, MarketError>;

impl MarketError {
    #[must_use]
    pub fn new(kind: ErrorKind, message: impl Into<Box<str>>) -> Self {
        Self {
            kind,
            message: message.into(),
            context: ErrorContext::default(),
        }
    }

    #[must_use]
    pub fn with_venue(mut self, venue: Venue, product: Product) -> Self {
        self.context.venue = Some(venue);
        self.context.product = Some(product);
        self
    }

    #[must_use]
    pub fn with_operation(mut self, operation: impl Into<Box<str>>) -> Self {
        self.context.operation = Some(operation.into());
        self
    }

    #[must_use]
    pub fn with_request_id(mut self, request_id: RequestId) -> Self {
        self.context.request_id = Some(request_id);
        self
    }

    #[must_use]
    pub fn with_native_code(mut self, native_code: impl Into<Box<str>>) -> Self {
        self.context.native_code = Some(native_code.into());
        self
    }

    #[must_use]
    pub const fn with_retriable(mut self, retriable: bool) -> Self {
        self.context.retriable = retriable;
        self
    }
}