Struct PMTilesWriter 

pub struct PMTilesWriter<W: Writer> { /* private fields */ }

(S2) PM Tiles Writer

Description

A PM or S2PM Tile Writer to store tile and metadata in a cloud optimized format

Implements the TileWriter interface.

Takes a Writer input to write data to.

Usage

The methods you have access to:

• PMTilesWriter::new: Create a new PMTilesWriter
• PMTilesWriter::take: Take ownership of the data (assuming local buffered data and not a filesystem writer)
• PMTilesWriter::write_tile: Write a tile to the PMTiles file given its tile ID.
• PMTilesWriter::write_tile_wm: Write a Web Mercator tile to the folder location given its (zoom, x, y) coordinates.
• PMTilesWriter::write_tile_s2: Write a S2 tile to the folder location given its (face, zoom, x, y) coordinates.
• PMTilesWriter::commit: Write the metadata to the folder location.

use gistools::{util::CompressionFormat, parsers::BufferWriter, writers::{TileWriter, PMTilesWriter}};
use s2_tilejson::Metadata;
use s2json::Face;

let local_writer = BufferWriter::default();
let mut pmtiles_writer = PMTilesWriter::new(local_writer, CompressionFormat::None);

// setup data
let tmp_str = "hello world";
// write data in tile
pmtiles_writer.write_tile_s2(Face::Face0, 0, 0, 0, tmp_str.as_bytes().to_vec());
pmtiles_writer.write_tile_s2(Face::Face3, 2, 1, 1, tmp_str.as_bytes().to_vec());
// finish (we don't need to specify the compression again)
pmtiles_writer.commit(Metadata::default(), None);

let pmtiles_data = pmtiles_writer.take();

Implementations

impl<W: Writer> PMTilesWriter<W>

pub fn new(writer: W, compression: CompressionFormat) -> Self

given a compression scheme and a data writer, create an instance to start storing tiles and metadata. Compression will only describle how tiles are stored, nothing more.

pub fn take(&mut self) -> Vec<u8>

take ownership of writer data (if local this actually has content)

pub fn write_tile(&mut self, tile_id: u64, data: &[u8], face: Option<Face>)

Write a tile to the PMTiles file given its tile ID.

Trait Implementations

impl<W: Debug + Writer> Debug for PMTilesWriter<W>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<W: Writer> TileWriter for PMTilesWriter<W>

fn write_tile_wm(&mut self, zoom: u8, x: u32, y: u32, data: Vec<u8>)

Write a Web Mercator tile to the folder location given its (zoom, x, y) coordinates.

fn write_tile_s2(&mut self, face: Face, zoom: u8, x: u32, y: u32, data: Vec<u8>)

Write a S2 tile to the folder location given its (face, zoom, x, y) coordinates.

fn commit( &mut self, metadata: Metadata, tile_compression: Option<CompressionFormat>, )

Write the metadata to the folder location.