lta-rs

🚍 Singapore LTA Datamall async first Rust client. lta-rs is used to interact with lta-datamall

lta-rs in action

Cargo.toml setup

```toml [dependencies]

extra features available: blocking

lta = { version = "0.6.0" } ```

API key setup

You can get your API key from here

```rust use lta::{LTAResult, LTAClient, Client, Traffic, TrafficRequests};

[tokio::main]

async fn main() -> LTAResult<()> { let apikey = std::env::var("APIKEY").expect("APIKEY not found!"); let client = LTAClient::withapikey(apikey)?; let erprates = Traffic::geterprates(&client, None).await?; println!("{:?}", erprates); Ok(()) } ```

Examples

Getting bus timings

```rust use lta::{LTAResult, LTAClient, Client, Bus, BusRequests};

fn getbusarrival() -> LTAResult<()> { let apikey = std::env::var("APIKEY").expect("APIKEY not found!"); let client = LTAClient::withapikey(apikey); let arrivals = Bus::get_arrival(&client, 83139, None)?; println!("{:?}", arrivals); Ok(()) } ```

Getting other data

``rust // All the APIs in this library are designed to be used like this //lta::RequestType::getsomething` // All of them return lta::utils::LTAResult // The example below is Bus::getbusservices() // and Traffic::geterprates() // Do note that the API calling convention is similar across all the APIs except for // bus::getarrival // Most of the APIs returns only 500 record // If you want to get records 501 - 1000 take a look at get_erp() example use lta::{LTAResult, LTAClient, Client, Bus, Traffic, BusRequests, TrafficRequests};

async fn busservices() -> LTAResult<()> { let apikey = std::env::var("APIKEY").expect("APIKEY not found!"); let client = LTAClient::withapikey(apikey)?; let busservices= Bus::getbusservices(&client, None)?; println!("{:?}", bus_services); Ok(()) }

async fn geterp() -> LTAResult<()> { let apikey = std::env::var("APIKEY").expect("APIKEY not found!"); let client = LTAClient::withapikey(apikey)?; let erprates = Traffic::geterprates(&client, 500)?; println!("{:?}", erp_rates); Ok(()) } ```

Custom Client

There are some instances where you might need to customise the reqwest client due to certain limitations.

```rust use lta::r#async::client::LTAClient; use lta::reqwest::ClientBuilder; use std::time::Duration; use lta::Client;

fn mycustomclient() -> LTAClient { let client = ClientBuilder::new() .nogzip() .connecttimeout(Duration::new(420, 0)) .build() .unwrap();

LTAClient::new("API_KEY", client)

} ```

General advice

Reuse LTAClient as it holds a connection pool internally
Reduce the number of times you call the API, take a look at Update Freq in the documentation and prevent yourself from getting blacklisted. Use a caching mechanism.

Getting help

You can get help via GitHub issues. I will try my best to respond to your queries :smile:

Changelog

Changelog can be found here

Requirements

Rust compiler 1.56

Frequently Asked Questions

Is this library being actively developed?
- Project is currently in maintenance mode. Won't really have any new features. Just bug fixes, minor upgrades etc.
What are the APIs available?
- All of the APIs are implemented. Take a look at the official LTA docs.
Where do I get the official docs from lta?
- You can get them here

License

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

Donations

For Singapore based users, you can donate using paylah!