versatiles_container 3.2.0

A toolbox for converting, checking and serving map tiles in various formats.
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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

# versatiles_container

Read, convert, and write tile containers for VersaTiles.

[![Crates.io](https://img.shields.io/crates/v/versatiles_container)](https://crates.io/crates/versatiles_container)
[![Documentation](https://docs.rs/versatiles_container/badge.svg)](https://docs.rs/versatiles_container)

## Overview

`versatiles_container` provides the I/O layer for working with map tile containers in multiple formats. It offers a unified interface for reading from and writing to various tile storage formats through a registry-based system with runtime composition.

This crate is designed for flexibility: readers are object-safe and can be wrapped by adapters (bbox filters, axis flips, compression overrides) before being written with the appropriate writer.

## Supported Formats

- **`.versatiles`**: Native VersaTiles container format
- **`.mbtiles`**: MBTiles (SQLite-based)
- **`.pmtiles`**: PMTiles (cloud-optimized)
- **`.tar`**: TAR archives
- **Directories**: Tile files in directory structures

## Features

- **Format Registry**: Automatic reader/writer selection based on file extension
- **Stream Processing**: Efficient tile streaming with minimal memory overhead
- **Runtime Composition**: Chain adapters to transform tile streams (filtering, compression, coordinate transforms)
- **Caching**: Built-in tile and metadata caching
- **Progress Tracking**: Monitor conversion progress with event bus

## Usage

```sh
cargo add versatiles_container versatiles_core
```

Or see [crates.io/crates/versatiles_container](https://crates.io/crates/versatiles_container) for version info and [docs.rs/versatiles_container](https://docs.rs/versatiles_container) for API documentation.

### Example

```rust
use versatiles_container::*;
use versatiles_core::*;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // Open a source container via the registry
    let runtime = TilesRuntime::default();
    let reader = runtime.get_reader_from_str("input.mbtiles").await?;

    // Optionally adapt the reader: limit to a bbox pyramid
    let params = TilesConverterParameters {
        bbox_pyramid: Some(TileBBoxPyramid::new_full(8)),
        ..Default::default()
    };
    let reader = Box::new(TilesConvertReader::new_from_reader(reader, params)?);

    // Write to a target path; format is inferred from the extension
    runtime.write_to_path(reader, "output.versatiles").await?;
    Ok(())
}
```

## API Documentation

For detailed API documentation, see [docs.rs/versatiles_container](https://docs.rs/versatiles_container).

## Part of VersaTiles

This crate is part of the [VersaTiles](https://github.com/versatiles-org/versatiles-rs) project, a toolbox for working with map tile containers in various formats.

For the complete toolset including CLI tools and servers, see the main [VersaTiles repository](https://github.com/versatiles-org/versatiles-rs).

## License

MIT License - see [LICENSE](https://github.com/versatiles-org/versatiles-rs/blob/main/LICENSE) for details.