mvt/lib.rs
1// lib.rs mvt crate.
2//
3// Copyright (c) 2019-2024 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 MapGrid::tile_transform
21//! let b = GeomEncoder::new(GeomType::Linestring)
22//! .point(0.0, 0.0)?
23//! .point(1024.0, 0.0)?
24//! .point(1024.0, 2048.0)?
25//! .point(2048.0, 2048.0)?
26//! .point(2048.0, 4096.0)?
27//! .encode()?;
28//! let mut feature = layer.into_feature(b);
29//! feature.set_id(1);
30//! feature.add_tag_string("key", "value");
31//! let layer = feature.into_layer();
32//! tile.add_layer(layer)?;
33//! let data = tile.to_bytes()?;
34//! println!("encoded {} bytes: {:?}", data.len(), data);
35//! Ok(())
36//! }
37//! ```
38//!
39//! [feature]: struct.Feature.html
40//! [layer]: struct.Layer.html
41//! [mapbox vector tiles]: https://github.com/mapbox/vector-tile-spec
42//! [tile]: struct.Tile.html
43#![forbid(unsafe_code)]
44
45mod encoder;
46mod error;
47mod geo;
48mod mapgrid;
49mod tile;
50mod vector_tile;
51
52pub use crate::encoder::{GeomData, GeomEncoder, GeomType};
53pub use crate::error::Error;
54pub use crate::geo::{WebMercatorPos, Wgs84Pos};
55pub use crate::mapgrid::{MapGrid, TileId};
56pub use crate::tile::{Feature, Layer, Tile};