mvt/lib.rs
1// lib.rs mvt crate.
2//
3// Copyright (c) 2019-2026 Minnesota Department of Transportation
4//
5//! A library for encoding [mapbox vector tiles].
6//!
7//! A [tile] is composed of one or more [layer]s. Each layer can have any number
8//! of [feature]s, which contain the geometry to be rendered. They can also have
9//! metadata tags, which are key/value pairs.
10//!
11//! ## Example
12//!
13//! ```rust
14//! use mvt::{Error, GeomEncoder, GeomType, Tile};
15//! use pointy::Transform;
16//!
17//! fn main() -> Result<(), Error> {
18//! let mut tile = Tile::new(4096);
19//! let layer = tile.create_layer("First Layer");
20//! // NOTE: normally, the `Transform` would come from
21//! // `squarepeg::MapGrid::transform_peg`
22//! let b = GeomEncoder::new(GeomType::Linestring)
23//! .point(0.0, 0.0)?
24//! .point(1024.0, 0.0)?
25//! .point(1024.0, 2048.0)?
26//! .point(2048.0, 2048.0)?
27//! .point(2048.0, 4096.0)?
28//! .encode()?;
29//! let mut feature = layer.into_feature(b);
30//! feature.set_id(1);
31//! feature.add_tag_string("key", "value");
32//! let layer = feature.into_layer();
33//! tile.add_layer(layer)?;
34//! let data = tile.to_bytes()?;
35//! println!("encoded {} bytes: {:?}", data.len(), data);
36//! Ok(())
37//! }
38//! ```
39//!
40//! [feature]: struct.Feature.html
41//! [layer]: struct.Layer.html
42//! [mapbox vector tiles]: https://github.com/mapbox/vector-tile-spec
43//! [tile]: struct.Tile.html
44#![forbid(unsafe_code)]
45
46mod encoder;
47mod error;
48mod tile;
49mod vector_tile;
50
51pub use crate::encoder::{GeomData, GeomEncoder, GeomType};
52pub use crate::error::Error;
53pub use crate::tile::{Feature, Layer, Tile};