fin_model/lib.rs
1/*!
2A comprehensive data model for various financial data.
3
4The purpose of this API is to construct a comprehensive data
5model for company and market financial information in a coherent
6and idiomatic manner, not of a specific service provider's API.
7
8This model can then be populated using requests described with
9traits and implemented by a given service provider. Thus, clients
10can use the common data model with Rust-native types and idioms
11but switch in different providers for different data types, markets,
12or qualities of service.
13
14This library only provides types and traits that can be implemented
15by a `Provider` that executes requests for financial data such as
16price quotes, analyst data, or company information. In the model
17we use the term _request trait_ to indicate a trait that contains
18functions that make a request for data and which use the common
19`RequestResult` response.
20*/
21
22extern crate chrono;
23#[macro_use]
24extern crate lazy_static;
25extern crate regex;
26extern crate steel_cent;
27
28// ------------------------------------------------------------------------------------------------
29// Public Modules
30// ------------------------------------------------------------------------------------------------
31
32pub mod prelude;
33
34pub mod analysis;
35
36pub mod classification;
37
38pub mod company;
39
40pub mod market;
41
42pub mod news;
43
44pub mod quote;
45
46pub mod registry;
47
48pub mod reporting;
49
50pub mod provider;
51
52pub mod request;
53
54pub mod symbol;