osmpbfreader-rs

Presentation

Read OpenStreetMap PBF files with rust. The main inspiration of this library is libosmpbfreader.

Tutorial

We'll see how to use this library to count the number of objects in an OSM PBF file.

First, install rust:

$ curl -s https://static.rust-lang.org/rustup.sh | sudo sh

Create a new cargo project:

$ cargo new --bin test-osmpbfreader
$ cd test-osmpbfreader/

Add dependency to osmpbfreader-rs by adding this to your Cargo.toml:

[dependencies.osmpbfreader]
git = "https://github.com/TeXitoi/osmpbfreader-rs"

and editing src/main.rs:

extern crate osmpbfreader;

fn main() {
    let filename = std::env::args_os().nth(1).unwrap();
    let path = std::path::Path::new(&filename);
    let r = std::fs::File::open(&path).unwrap();
    let mut pbf = osmpbfreader::OsmPbfReader::new(r);
    let mut nb = 0;
    for _obj in pbf.iter() {
        nb += 1;
    }
    println!("{} objects in {:?}", nb, filename);
}

build and run:

$ cargo build --release
$ ./target/test-osmpbfreader picardie-latest.osm.pbf
9852873 objects in "picardie-latest.osm.pbf"

You can find OSM PBF files at Geofabrik's free download server.

Performances

Using the count example compiled in release mode:

$ cat /proc/cpuinfo | grep name | head -1
model name	: Intel(R) Core(TM) i7-4702HQ CPU @ 2.20GHz
$ rustc --version
rustc 0.13.0-nightly (fac5a0767 2014-11-26 22:37:06 +0000)
$ ls -sh france-latest.osm.pbf
2,9G france-latest.osm.pbf
$ time ./target/release/count-osm france-latest.osm.pbf admin_level 8
counting objects with tags["admin_level"] = "8"...
51 nodes, mean coord: 46.337052, 2.832865.
105306 ways, mean |nodes|: 75.646221
37229 relations, mean |references|: 8.220446

real	5m30.785s
user	5m18.264s
sys 	0m11.944s

License

This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See the COPYING file for more details.

Note that src/fileformat.proto and src/osmformat.proto come from OSM-binary under the LGPLv3.

TODO

TODO list: