galileo 0.2.1

Cross-platform general purpose map rendering engine
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

//! Vector tile processor.

use std::sync::Arc;

use galileo_mvt::MvtTile;
use maybe_sync::{MaybeSend, MaybeSync};
use serde::{Deserialize, Serialize};

use crate::layer::vector_tile_layer::style::VectorTileStyle;
use crate::layer::vector_tile_layer::tile_provider::VtStyleId;
use crate::render::render_bundle::RenderBundle;
use crate::tile_schema::TileIndex;

/// Error while processing vector tile.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum TileProcessingError {
    /// Style with the given style id is not registered.
    InvalidStyle,
    /// Failed to render the tile.
    Rendering,
    /// Something went wrong.
    Internal,
}

/// Processor of vector tiles that converts raw tiles into render bundles ready to be displayed on
/// the map.
#[cfg_attr(target_arch = "wasm32", async_trait::async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait::async_trait)]
pub trait VectorTileProcessor: MaybeSend + MaybeSync {
    /// Returns try if a style with the given id was registered.
    fn has_style(&self, style_id: VtStyleId) -> bool;
    /// Returns a style with the given id.
    fn get_style(&self, style_id: VtStyleId) -> Option<Arc<VectorTileStyle>>;
    /// Registers a vector tile style.
    fn add_style(&self, style_id: VtStyleId, style: VectorTileStyle);
    /// Removes the style from the list.
    fn drop_style(&self, style_id: VtStyleId);
    /// Convert the tile into render bundle using the given style.
    ///
    /// The style with the given id must first be registered in the processor using
    /// [`VectorTileProcessor::add_style()`] method.
    async fn process_tile(
        &self,
        tile: Arc<MvtTile>,
        index: TileIndex,
        style_id: VtStyleId,
    ) -> Result<RenderBundle, TileProcessingError>;
}