20 stable releases (16 major)

16.0.0 Mar 8, 2024
15.0.0 Oct 22, 2023
14.0.0 Apr 24, 2023
13.1.0 Apr 23, 2023
0.1.0 Feb 24, 2021

#1294 in Parser implementations

Download history 23/week @ 2024-02-15 36/week @ 2024-02-22 1/week @ 2024-02-29 154/week @ 2024-03-07 9/week @ 2024-03-14

215 downloads per month

MIT license

740KB
639 lines

pipeline status

adsbx_json

This is a Rust library for parsing the JSON returned by the ADS-B Exchange API. It currently supports version 2 of the API.

Goals & thoughts

The goal of this library is to be a fast, type-safe interface to all the data returned by both v1 and v2 of the ADS-B Exchange API.

The ADS-B JSON format evolves pretty continuously, not always in a backwards compatible way. Currently I prefer to use this library in a mode where it errors out if it even sees an unexpected field in the JSON, because it helps highlight those changes when they occur, but that makes more sense for me, as a developer of the library than it probably does for users. I'm not sure serde offers a way to choose at runtime whether to turn off those strict checks.

Status

Alpha, unstable. Handles all of v2 of the ADS-B Exchange API. Does not handle v1 at all.

Currently parses about 250,000-300,000 aircraft objects per second.

Development

Build:

cargo build

Build examples in release mode:

cargo build --release --examples fetch

Run unit and integration tests:

cargo test

Run example code:

ADSBX_API_KEY=xxx cargo run --example fetch -- --url https://adsbexchange.com/api/aircraft/v2/all

Output:

Got 3734 aircraft.
Aircraft {
    adsb_version: None,
    aircraft_type: Some(
        "A320",
    ),
    baro_rate: Some(
        -2170,
    ),
    barometric_altitude: Some(
        Altitude(
            12675,
        ),
    ),
    calc_track: None,
    call_sign: Some(
        "NKS907  ",
    ),
[...]

Run benchmarks:

cargo bench

Dependencies

~2.3–9.5MB
~68K SLoC