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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

#![forbid(unsafe_code)]
#![warn(clippy::all)]
#![cfg_attr(coverage, feature(no_coverage))]

//! A Simple, Lightweight, Fast and Safe Fugle Library.
//!
//! What is [Fugle][fugleweb]
//!
//! This is a library of rust version to access Fugle's
//!
//! * RESTful API
//! * Websocket (enable websocket feature)
//!
//! services in a very easy way.
//!
//! ## Examples
//!
//! for more please reference to the examples folder
//!
//!
//! ### [Fugle Chart][fuglechartweb]
//!
//! Restful API
//! ```rust
//! # fn main() -> fugle::schema::Result<()> {
//! # use fugle::http::{ RestfulBuilder, intraday::ChartRequest };
//! #
//! let client = RestfulBuilder::new().build()?;
//! client.call(ChartRequest::new().symbol_id("2884"))?;
//! #
//! # Ok(())
//! # }
//! ```
//!
//! Websocket
//! ```rust no_run
//! # fn main() -> fugle::schema::Result<()> {
//! # use fugle::websocket::IntradayBuilder;
//! #
//! let mut ws = IntradayBuilder::new().symbol_id("2884").odd_lot().build();
//!                                                            
//! let rx = ws.chart()?;
//! let response = rx.recv()?;
//! #
//! # Ok(())
//! # }
//! ```
//!
//! ### [Fugle Quote][fuglequoteweb]
//!
//! Restful API
//! ```rust
//! # fn main() -> fugle::schema::Result<()> {
//! # use fugle::http::{ RestfulBuilder, intraday::QuoteRequest };
//! #
//! let client = RestfulBuilder::new().build()?;
//! client.call(QuoteRequest::new().symbol_id("2884"))?;
//! #
//! # Ok(())
//! # }
//! ```
//!
//! Websocket
//! ```rust no_run
//! # fn main() -> fugle::schema::Result<()> {
//! # use fugle::websocket::IntradayBuilder;;
//! #
//! let mut ws = IntradayBuilder::new().symbol_id("2884").odd_lot().build();
//!                                                            
//! let rx = ws.quote()?;
//! let response = rx.recv()?;
//! #
//! # Ok(())
//! # }
//! ```
//!
//! ### [Fugle Meta][fuglemetaweb]
//!
//! Restful API
//! ```rust
//! # fn main() -> fugle::schema::Result<()> {
//! # use fugle::http::{ RestfulBuilder, intraday::MetaRequest };
//! #
//! let client = RestfulBuilder::new().build()?;
//! client.call(MetaRequest::new().symbol_id("2884"))?;
//! #
//! # Ok(())
//! # }
//! ```
//!
//! Websocket
//! ```rust no_run
//! # fn main() -> fugle::schema::Result<()> {
//! # use fugle::websocket::IntradayBuilder;;
//! #
//! let mut lis = IntradayBuilder::new().symbol_id("2884").odd_lot().build();
//!                                                            
//! let rx = lis.meta()?;
//! let response = rx.recv()?;
//! #
//! # Ok(())
//! # }
//! ```
//!
//! ### [Fugle Dealts][fugledealtsweb]
//!
//! Restful API
//! ```rust
//! # fn main() -> fugle::schema::Result<()> {
//! # use fugle::http::{ RestfulBuilder, intraday::DealtsRequest };
//! #
//! let client = RestfulBuilder::new().build()?;
//! client.call(
//!     DealtsRequest::new()
//!     .symbol_id("2884")
//!     .limit(10)
//!     .offset(0)
//! )?;
//! #
//! # Ok(())
//! # }
//! ```
//!
//! ### [Fugle Volumes][fuglevolumesweb]
//!
//! Restful API
//! ```rust
//! # fn main() -> fugle::schema::Result<()> {
//! # use fugle::http::{ RestfulBuilder, intraday::VolumesRequest };
//! #
//! let client = RestfulBuilder::new().build()?;
//! client.call(VolumesRequest::new().symbol_id("2884"))?;
//! #
//! # Ok(())
//! # }
//! ```
//!
//! ### [Fugle Candles][fuglecandlesweb]
//!
//! Restful API
//! ```rust
//! # fn main() -> fugle::schema::Result<()> {
//! # use fugle::http::{ RestfulBuilder, marketdata::CandlesRequest };
//! #
//! let client = RestfulBuilder::new().build()?;
//! client.call(
//!     CandlesRequest::new()
//!     .symbol_id("2884")
//!     .from("2022-08-01")
//!     .to("2022-08-08")
//! )?;
//! #
//! # Ok(())
//! # }
//! ```
//!
//! [fugleweb]: https://developer.fugle.tw
//! [fuglechartweb]: https://developer.fugle.tw/docs/data/intraday/chart
//! [fuglequoteweb]: https://developer.fugle.tw/docs/data/intraday/quote
//! [fuglemetaweb]: https://developer.fugle.tw/docs/data/intraday/meta
//! [fugledealtsweb]: https://developer.fugle.tw/docs/data/intraday/dealts
//! [fuglevolumesweb]: https://developer.fugle.tw/docs/data/intraday/volumes
//! [fuglecandlesweb]: https://developer.fugle.tw/docs/data/marketdata/candles

pub mod errors;
pub mod http;
pub mod schema;
#[cfg(any(feature = "websocket", feature = "async-websocket"))]
pub mod websocket;