wmata

wmata is a high level Rust interface to the Washington Metropolitan Area Transit Authority API.

Contents

• Requirements
• Installation
• Usage
  • Getting Started
  • Design
  • Using MetroRail
  • Using MetroBus
• Testing
• Dependencies
• Contact
• License

Requirements

• Rust 2018

Installation

Cargo

wmata = "3.0.0"

Usage

Getting Started

use wmata::MetroRail;

let client = MetroRail::new(api_key);

let trains = client.next_trains()?;

Design

wmata breaks the WMATA API into two components: MetroRail and MetroBus.

MetroRail

Provides access to all MetroRail related endpoints.

Using MetroRail

use wmata::MetroRail;

let client = MetroRail::new(api_key);

let trains = client.next_trains()?;

MetroBus

Provides access to all MetroBus related endpoints.

Using MetroBus

use wmata::MetroBus;

let client = MetroBus::new(api_key);

let routes = client.routes()?;

Testing

Note that tests must currently be run with --test-threads 1 in order to pass, due to using live data.

Dependencies

• serde
• serde_json
• reqwest

Contact

Feel free to email questions and comments to emma@emma.sh

License

wmata is released under the MIT license. See LICENSE for details.