https://github.com/arma-place/pmtiles-rs

This crate includes a low level implementation of the PMTiles format based on the standard Read and Write trait.
https://github.com/arma-place/pmtiles-rs

decoding encoding pmtiles rust

Last synced: 3 months ago
JSON representation

This crate includes a low level implementation of the PMTiles format based on the standard Read and Write trait.

• Host: GitHub
• URL: https://github.com/arma-place/pmtiles-rs
• Owner: arma-place
• License: mit
• Created: 2022-12-14T17:58:59.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-05-25T10:27:46.000Z (6 months ago)
• Last Synced: 2024-06-25T09:37:22.959Z (5 months ago)
• Topics: decoding, encoding, pmtiles, rust
• Language: Rust
• Homepage:
• Size: 4.61 MB
• Stars: 11
• Watchers: 2
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-georust - PMTiles (for Rust) - Low level implementation of the PMTiles format (Watchlist)

README

        
# PMTiles (for Rust) [![crates.io](https://img.shields.io/crates/v/pmtiles2?style=flat-square&logo=rust)](https://crates.io/crates/pmtiles2) [![docs.rs](https://img.shields.io/badge/docs.rs-pmtiles2-66c2a5.svg?logo=docs.rs&style=flat-square)](https://docs.rs/pmtiles2) [![build status](https://img.shields.io/github/actions/workflow/status/arma-place/pmtiles-rs/CI.yml?branch=master&style=flat-square)](https://github.com/arma-place/pmtiles-rs/actions?query=branch%3Amaster)

This crate includes a low level implementation of [the PMTiles format](https://github.com/protomaps/PMTiles) based on the standard [Read](https://doc.rust-lang.org/std/io/trait.Read.html) and [Write](https://doc.rust-lang.org/std/io/trait.Write.html) (or [AsyncRead](https://docs.rs/futures/latest/futures/io/trait.AsyncRead.html) and [AsyncWrite](https://docs.rs/futures/latest/futures/io/trait.AsyncWrite.html) from the [`futures`-crate](https://docs.rs/futures/latest/futures/index.html)) traits.

It also contains [some utilities](https://docs.rs/pmtiles2/latest/pmtiles2/util/), 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](https://docs.rs/pmtiles2).

The documentation includes some examples.

## Installation

Add following lines to your Cargo.toml:

```toml

# Cargo.toml

[dependencies]

pmtiles2 = "0.3"

```

## Features

### `serde`

With this feature enabled most public types are (de-)serializable by [serde](https://crates.io/crates/serde).

### `async`

With this feature enabled all readable / writable types also support asynchronous readers / writers via the [AsyncRead](https://docs.rs/futures/latest/futures/io/trait.AsyncRead.html) and [AsyncWrite](https://docs.rs/futures/latest/futures/io/trait.AsyncWrite.html) traits from the [`futures`-crate](https://docs.rs/futures/latest/futures/index.html).