versatiles_derive 3.6.1

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

# versatiles_derive

Procedural macros for the VersaTiles ecosystem.

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

## Overview

This crate provides derive macros and attribute macros used internally by VersaTiles for code generation and ergonomic error handling.

### Provided Macros

- **`#[derive(VPLDecode)]`**: Automatically generates decoding logic for VPL (VersaTiles Pipeline Language) data structures
- **`#[derive(ConfigDoc)]`**: Generates YAML configuration documentation from struct definitions
- **`#[context("...")]`**: Adds contextual error messages to functions returning `Result`

## Usage

This crate is primarily for internal use within the VersaTiles project. If you're using VersaTiles as a library, you typically won't need to use this crate directly.

```sh
cargo add versatiles_derive
```

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

### Example

```rust
use versatiles_derive::{VPLDecode, context};
use anyhow::Result;

#[derive(VPLDecode)]
struct MyConfig {
    name: String,
    value: u32,
}

#[context("failed to process data")]
fn process() -> Result<()> {
    // Errors will include "failed to process data" context
    Ok(())
}
```

## API Documentation

For detailed API documentation and macro usage, see [docs.rs/versatiles_derive](https://docs.rs/versatiles_derive).

## Part of VersaTiles

This crate is part of the [VersaTiles](https://github.com/versatiles-org/versatiles-rs) project.

## License

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