pmtiles

Crates.iopmtiles
lib.rspmtiles
version0.11.0
sourcesrc
created_at2022-10-21 21:56:32.651552
updated_at2024-09-20 10:36:15.251529
descriptionImplementation of the PMTiles v3 spec with multiple sync and async backends.
homepage
repositoryhttps://github.com/stadiamaps/pmtiles-rs
max_upload_size
id693954
size4,751,177
Yuri Astrakhan (nyurik)

documentation

README

PMTiles (for Rust)

GitHub crates.io version docs.rs docs crates.io version CI build

This crate implements the PMTiles v3 spec, originally created by Brandon Liu for Protomaps.

Features

  • Opening and validating PMTile archives
  • Querying tiles
  • Backends supported:
    • Async mmap (Tokio) for local files
    • Async http and https (Reqwuest + Tokio) for URLs
    • Async s3 (Rust-S3 + Tokio) for S3-compatible buckets

Plans & TODOs

  • Documentation and example code
  • Support writing and conversion to and from MBTiles + x/y/z
  • Support additional backends (sync mmap and http at least)
  • Support additional async styles (e.g., async-std)

PRs welcome!

Development

  • This project is easier to develop with just, a modern alternative to make. Install it with cargo install just.
  • To get a list of available commands, run just.
  • To run tests, use just test.

License

Licensed under either of

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Test Data License

Some PMTile fixtures copied from official PMTiles repository.

Commit count: 61

cargo fmt