pbf-craft 1.0.2

A Rust library for reading and writing OpenSteetMap PBF file format.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

use std::rc::Rc;

use crate::models::{Node, Relation, Way};

/// The decoded contents of a single PBF data blob.
///
/// Produced by [`PbfReader::read_next_blob`](crate::readers::PbfReader::read_next_blob) and
/// consumed by the indexed readers. `offset` is the byte offset of the blob in the stream,
/// used for random access.
pub struct BlobData {
    pub nodes: Vec<Node>,
    pub ways: Vec<Way>,
    pub relations: Vec<Relation>,
    pub offset: u64,
}

/// Random access to a PBF stream by blob offset.
///
/// Implemented by [`PbfReader`](crate::readers::PbfReader) and
/// [`CachedReader`](crate::readers::CachedReader) (which adds an in-memory blob cache).
pub trait PbfRandomRead {
    /// Reads and decodes the blob starting at the given byte offset.
    fn read_blob_by_offset(&mut self, offset: u64) -> anyhow::Result<Rc<BlobData>>;
}