lta 0.1.0

🚍 Singapore LTA Datamall Rust Client written in pure rust
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

# lta-rs

> lta-rs is a lta datamall client library written in pure safe rust. lta-rs is used to interact with the [lta-datamall](https://www.mytransport.sg/content/mytransport/home/dataMall.html)

## lta-rust in action


### Cargo.toml setup

```toml
[dependencies]
# for now, I will add to crates.io once its ready

lta = { git = "https://github.com/BudiNverse/lta-rs", branch = "0.1" }
```

### API key setup

You can get your API key from [here](https://www.mytransport.sg/content/mytransport/home/dataMall/request-for-api.html)

```rust
extern crate lta;

use lta::client_config::{ CLIENT_CONFIG };

fn main() {
    // should only be set once
    CLIENT_CONFIG.lock().unwrap().with_api_key("Your key here");
    // your other stuff here
    // .
    // .
    // .
}

```

### Examples


Getting bus timings
```rust
use lta::bus::bus_arrival;

fn get_arrivals() {
    let resp: Result<BusArrivalResp, Error> = bus_arrival(83139, "15");
    match resp {
        Ok(bus_arrival_resp) => println!("{:?}", bus_arrival_resp),
        Err(e) => println!("{:?}", e)
    };
}
```

Getting anything else
```rust
// All the APIs in this library are designed to be used like this
// `module::get_something`
// All of them return Result<Vec<T>, Error>
// The example below is bus::get_bus_services()
// and traffic::get_erp_rates()
// Do note that the API is similar across all the APIs except for
// bus::get_bus_arrival
use lta::bus::get_bus_services;

fn get_bus_services() {
    let resp: Result<Vec<BusService>, Error> = bus::get_bus_services();
    match resp {
        Ok(r) => println!("{:?}", r),
        Err(e) => println!("{:?}", e)
    };
}

fn get_erp_rates() {
    let resp: Result<Vec<ErpRate>, Error> = traffic::get_erp_rates();
    match resp {
        Ok(r) => println!("{:?}", r),
        Err(e) => println!("{:?}", e)
    };
}
```

### Getting help

- Take a look at the docs on docs.rs
- You can get help via github issues. I will try my best to respond to your queries :smile:

### Design decisions

- Made sure that Rust structs are as close to the original response as possible to make sure that people can reference the original docs if there are any issues 
- Simple and no additional baggage. Only the client is included. E.g If anyone wants to add concurrency, they have to do it their own

### Changelog

Version 0.1
- All endpoints that are available from lta datamall website
- Configuration using API

### License

lta-rs is licensed under MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

### Frequently Asked Questions


> Where do I get the official docs from lta?

You can get them [here](https://www.mytransport.sg/content/dam/datamall/datasets/LTA_DataMall_API_User_Guide.pdf)

> Why are some of the datatypes different from the lta documentation?

Some of the datatypes returned are not ideal such as returning `lat` and `lang` as `string` rather than `number`. Some of the types are also converted to enums to reduce the number of stringly typed stuff

> My application panicked.

Check if your API key is valid, if not create a github issue

> Is this project affiliated to LTA or any government bodies?

No

### Common Technical Questions

- [EOF while parsing a value](https://github.com/BudiNverse/lta-rs/issues/1)
- [API key not init!](https://github.com/BudiNverse/lta-rs/issues/2)
- [No such known host](https://github.com/BudiNverse/lta-rs/issues/3)