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

/*!
Provides the trait required by service provider implementations.


Before implementing any _request traits_ a service provider needs to
implement the `Provider` trait. This is the mechanism by which a client
instantiates a specific service provider.
*/

use crate::request::RequestResult;

// ------------------------------------------------------------------------------------------------
// Public Traits
// ------------------------------------------------------------------------------------------------

/// This trait allows a client to create a provider instance as
/// well as introspect basic descriptive properties.
pub trait Provider
where
    Self: std::marker::Sized,
{
    /// Create a new instance, performing any initialization which _may_
    /// involve a network operation, to perform authentication for example.
    fn new() -> RequestResult<Self>;

    /// A string that can be used to name or describe the provider.
    fn attribution(&self) -> String;

    /// The URL to the provider's home page or documentation.
    fn url(&self) -> String;

    /// The default currency code, using ISO three-character code.
    fn get_default_currency(&self) -> &String;

    /// Optional, if the provider needs to close or complete any resources when done.
    fn finish(&self);
}