fin_model 0.1.2

The provider-neutral model for financial operations.
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

/*!
Provides the common `Result` type and error enum used by _request traits_.

## Example

```rust
pub trait Peers {
    fn peers(&self, for_symbol: Symbol) -> RequestResult<Snapshot<Vec<Symbol>>>;
}
```
*/

// ------------------------------------------------------------------------------------------------
// Public Types
// ------------------------------------------------------------------------------------------------

/// The common error responses returned from _request traits_.
#[derive(Debug)]
pub enum RequestError {
    /// Usually a response from `Provider::new` this indicates that some
    /// error occurred due to missing or invalid configuration data.
    ConfigurationError(String),

    /// Failure to communicate with the service provider, where no additional
    /// information or specific type can be determined.
    CommunicationError,

    /// Failure to authenticate, this could be a wrapper around an OAuth
    /// error, or a missing/invalid token rejected by the service provider.
    AuthenticationError,

    /// Your current session/identity does not permit the requested operation.
    AuthorizationError,

    /// The symbol you passed to the `Provider` is not valid.
    BadSymbolError(String),

    /// Something in the request was incorrect. This error may be returned
    /// from the local `Provider` implementation or wrap an error returned
    /// from the service provider.
    BadRequestError,

    /// Something in the response from the service provider was incorrect.
    /// This error is _usually_ returned from the local `Provider`
    /// implementation due to de-serialization failure.
    BadResponseError,

    /// The service provider is throttling requests, either globally or
    /// specifically for your identity.
    RequestThrottled,

    /// This can be used to indicate that a given operation is unsupported
    /// by the `Provider`. This may mean that 1) it is not supported by the
    /// service provider itself, 2) it is not _yet_ implemented by the
    /// `Provider`, or 3) may never be implemented. A provider implementation
    /// that returns this error should indicate in documentation why
    /// this is the case.
    Unsupported,
}

/// The common `Result` returned from _request traits_; the success type is
/// unspecified but the error is always `RequestError`.
pub type RequestResult<T> = Result<T, RequestError>;

// ------------------------------------------------------------------------------------------------
// Trait Implementations
// ------------------------------------------------------------------------------------------------

impl RequestError {
    /// Return a `RequestError` from an HTTP status code as a `u16` value.
    #[allow(ellipsis_inclusive_range_patterns)]
    pub fn from_u16(code: u16) -> Option<Self> {
        match code {
            100...299 => None,

            401 | 407 => Some(RequestError::AuthenticationError),
            403 | 451 => Some(RequestError::AuthorizationError),
            400 | 404...406 | 411...417 | 426...428 | 431 => Some(RequestError::BadRequestError),
            429 => Some(RequestError::RequestThrottled),

            501 => Some(RequestError::Unsupported),
            505 | 506 => Some(RequestError::BadRequestError),
            511 => Some(RequestError::AuthorizationError),

            _ => Some(RequestError::CommunicationError),
        }
    }
}