Struct PMTilesReader 

pub struct PMTilesReader<R: Reader> { /* private fields */ }

(S2) PMTiles Reader

Description

A V3.0 PMTiles reader for reading standard WebMercator Tile data and V1.0 S2 Tile data.

A Modified implementation of the PMTiles library. It is backwards compatible but offers support for the S2 Projection.

You can learn more about the S2PMTiles Specification here.

Usage

PMTilesReader utilizes any struct that implements the Reader trait. Options are crate::parsers::BufferReader, crate::parsers::FileReader, crate::parsers::MMapReader, and crate::parsers::FetchReader.

The methods you have access to:

• PMTilesReader::new: Create a new PMTilesReader
• PMTilesReader::get_header: Get the PMTiles header
• PMTilesReader::get_s2_metadata: Get the S2 PMTiles metadata
• PMTilesReader::get_metadata: Get the PMTiles metadata
• PMTilesReader::get_tile_s2: Get an S2 Tile
• PMTilesReader::get_tile_wm: Get an WM Tile
• PMTilesReader::get_tile: Get a Tile irregardless of the projection type

use gistools::{parsers::FileReader, readers::PMTilesReader};
use std::path::PathBuf;

let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
    .join("tests/readers/pmtiles/fixtures/test_fixture_1.pmtiles");
let file_reader = FileReader::new(path).unwrap();
let mut reader = PMTilesReader::new(file_reader, None);

smol::block_on(async {

// pull out the header
let header = reader.get_header().await;

// get the metadata
let metadata = reader.get_metadata();

// S2 specific functions
let tile = reader.get_tile_s2(0.into(), 0, 0, 0).await;

// WM functions
let tile = reader.get_tile_wm(0, 0, 0).await.unwrap();

});

Links

• https://github.com/Open-S2/s2-pmtiles
• https://github.com/Open-S2/s2-pmtiles/blob/master/s2-pmtiles-spec/1.0.0/README.md
• https://github.com/protomaps/PMTiles
• https://github.com/protomaps/PMTiles/blob/main/spec/v3/spec.md

Implementations

impl<R: Reader> PMTilesReader<R>

pub fn new(reader: R, max_size: Option<usize>) -> Self

Given an input path, read in the header and root directory

pub async fn get_header(&mut self) -> S2PMHeader

fetch the s2 metadata as needed

pub fn get_s2_metadata(&mut self, data: &[u8], header: &mut S2PMHeader)

If S2, we need to build the other face’s root directories

pub fn get_metadata(&mut self) -> &Metadata

get the metadata

pub async fn get_tile_s2( &mut self, face: Face, zoom: u8, x: u64, y: u64, ) -> Option<Vec<u8>>

get an S2 tile

pub async fn get_tile_wm(&mut self, zoom: u8, x: u64, y: u64) -> Option<Vec<u8>>

get an WM tile

pub async fn get_tile( &mut self, face: Option<Face>, zoom: u8, x: u64, y: u64, ) -> Option<Vec<u8>>

get a tile, wheather WM or S2

Trait Implementations

impl<R: Debug + Reader> Debug for PMTilesReader<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.