Struct S2TilesWriter 

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

S2 Tiles Writer

Description

An S2 Tile Writer to store tile and metadata in a cloud optimized format. Similar to PMTiles but simplified to have as few features as possible.

Writes either a Web Mercator tile or an S2 tile to the folder location given its (zoom, x, y) or (face, zoom, x, y) coordinates.

Usage

This struct uses the TileWriter trait.

Takes a Writer input to write data to.

The methods you have access to:

• S2TilesWriter::new: Create a new S2TilesWriter
• S2TilesWriter::write_tile_wm: Write a Web Mercator tile to the folder location given its (zoom, x, y) coordinates.
• S2TilesWriter::write_tile_s2: Write a S2 tile to the folder location given its (face, zoom, x, y) coordinates.
• S2TilesWriter::commit: Write the metadata to the folder location.
• S2TilesWriter::writer: Borrow the writer mutably if needed
• S2TilesWriter::put_tile_fzxy: Write a tile to the S2Tiles file given its (face, zoom, x, y) coordinates.
• S2TilesWriter::put_tile: Inserts a tile into the S2Tiles store.

use gistools::{
    parsers::{BufferWriter, Writer},
    util::CompressionFormat,
    writers::{S2TilesWriter, TileWriter},
};
use s2_tilejson::Metadata;

let local_writer = BufferWriter::default();
let mut s2tiles_writer = S2TilesWriter::new(local_writer, 9, CompressionFormat::None);

let s = String::from("hello world");
let buf = s.as_bytes().to_vec();

// write data in an wm tile
s2tiles_writer.write_tile_wm(0, 0, 0, buf.clone());
// or write data in an s2 tile
s2tiles_writer.write_tile_s2(0.into(), 0, 0, 0, buf.clone());

// finish
s2tiles_writer.commit(Metadata::default(), None);

Links

• https://github.com/Open-S2/s2tiles/blob/master/s2tiles-spec/1.0.0/README.md

Implementations

impl<W: Writer> S2TilesWriter<W>

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

given a compression scheme, maxzoom, and a data writer, create an instance to start storing tiles and metadata. Compression describes how both the tiles and the metadata are compressed

pub fn writer(&mut self) -> &mut W

Borrow the writer

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

Write a tile to the S2Tiles file given its (face, zoom, x, y) coordinates.

Parameters

• face: the Open S2 projection face
• zoom: the zoom level
• x: the tile X coordinate
• y: the tile Y coordinate
• data: the tile data to store

pub fn put_tile(&mut self, id: S2CellId, data: Vec<u8>)

Inserts a tile into the S2Tiles store.

Parameters

• id: the tile ID
• data: the tile data

Trait Implementations

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

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

Formats the value using the given formatter.

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

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

Finish writing by building the header with root and leaf directories

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.