Struct osmpbfreader::reader::OsmPbfReader

pub struct OsmPbfReader<R> { /* fields omitted */ }

The object to manage a pbf file.

Methods

impl<R: Read> OsmPbfReader<R>

pub fn new(r: R) -> OsmPbfReader<R>

Creates an OsmPbfReader from a Read object.

Important traits for Iter<'a, R>

impl<'a, R> Iterator for Iter<'a, R> where
    R: Read + 'a,  type Item = <FlatMap<Blobs<'a, R>, OsmObjs, fn(_: Result<Blob>) -> OsmObjs> as Iterator>::Item;

pub fn iter(&mut self) -> Iter<R>

Returns an iterator on the OsmObj of the pbf file.

#Example

let mut pbf = osmpbfreader::OsmPbfReader::new(std::io::empty());
for obj in pbf.iter().map(Result::unwrap) {
    println!("{:?}", obj);
}

Important traits for ParIter<'a, R>

impl<'a, R> Iterator for ParIter<'a, R> where
    R: Read + 'a,  type Item = <FlatMap<Blobs<'a, R>, OsmObjs, fn(_: Result<Blob>) -> OsmObjs> as Iterator>::Item;

pub fn par_iter<'a>(&'a mut self) -> ParIter<'a, R>

Returns a parallel iterator on the OsmObj of the pbf file.

Several threads decode in parallel the file. The memory and CPU usage are guaranteed to be bounded even if the caller stop consuming items.

#Example

let mut pbf = osmpbfreader::OsmPbfReader::new(std::io::empty());
for obj in pbf.par_iter().map(Result::unwrap) {
    println!("{:?}", obj);
}

pub fn rewind(&mut self) -> Result<()> where
    R: Seek, 

Rewinds the pbf file to the begining.

Useful if you want to read several consecutive times the same file.

Example

let mut cursor = std::io::Cursor::new([0, 0, 0]);
cursor.set_position(2);
let mut pbf = osmpbfreader::OsmPbfReader::new(cursor);
pbf.rewind().unwrap();
assert_eq!(pbf.into_inner().position(), 0);

pub fn get_objs_and_deps<F>(
    &mut self,
    pred: F
) -> Result<BTreeMap<OsmId, OsmObj>> where
    R: Seek,
    F: FnMut(&OsmObj) -> bool, 

This function give you the ability to find all the objects validating a predicate and all there dependencies. The file will be decoded in parallel.

Example

If you want to extract all the administrative boundaries and all there dependencies you can do something like that:

fn is_admin(obj: &osmpbfreader::OsmObj) -> bool {
    // get relations with tags[boundary] == administrative
    obj.is_relation() && obj.tags().contains("boundary", "administrative")
}

let mut pbf = osmpbfreader::OsmPbfReader::new(std::io::Cursor::new([]));
let objs = pbf.get_objs_and_deps(is_admin).unwrap();
for (id, obj) in &objs {
    println!("{:?}: {:?}", id, obj);
}

pub fn into_inner(self) -> R

Extract the Read object.

Consumes the object.

Important traits for Blobs<'a, R>

impl<'a, R: Read> Iterator for Blobs<'a, R> type Item = Result<Blob>;

pub fn blobs(&mut self) -> Blobs<R>

Returns an iterator on the blobs of the pbf file.

Important traits for PrimitiveBlocks<'a, R>

impl<'a, R> Iterator for PrimitiveBlocks<'a, R> where
    R: Read + 'a,  type Item = <Map<Blobs<'a, R>, fn(_: Result<Blob>) -> Result<PrimitiveBlock>> as Iterator>::Item;

pub fn primitive_blocks(&mut self) -> PrimitiveBlocks<R>

Returns an iterator on the blocks of the pbf file.

Trait Implementations