search

arma-place / pmtiles-rs

This crate includes a low level implementation of the PMTiles format based on the standard Read and Write trait.
MIT License
13 stars 2 forks source link
decoding encoding pmtiles rust

readme

PMTiles (for Rust) crates.io docs.rs build status

This crate includes a low level implementation of the PMTiles format based on the standard Read and Write (or AsyncRead and AsyncWrite from the futures-crate) traits.

It also contains some utilities, which might become handy when working with PMTiles archives. Among others these include functions for (de-)compression with all algorithms supported by PMTiles, as well as functions to convert from and to tile ids.

Documentation

See RustDoc Documentation.

The documentation includes some examples.

Installation

Add following lines to your Cargo.toml:

# Cargo.toml
[dependencies]
pmtiles2 = "0.3"

Features

serde

With this feature enabled most public types are (de-)serializable by serde.

async

With this feature enabled all readable / writable types also support asynchronous readers / writers via the AsyncRead and AsyncWrite traits from the futures-crate.