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
49
50
51
52

//! Provides platform specific logic and [`PlatformService`] to access it.

use async_trait::async_trait;
use bytes::Bytes;
use lazy_static::lazy_static;

use crate::decoded_image::DecodedImage;
use crate::error::GalileoError;

/// Service providing some platform specific functions in a generic way.
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
pub trait PlatformService {
    /// Creates a new instance of the service. This method is a part of the trait to allow other
    /// types be agnostic of the specific type of the platform service they work with.
    fn new() -> Self;
    /// Loads and decodes an image from the given url.
    async fn load_image_url(&self, url: &str) -> Result<DecodedImage, GalileoError>;
    /// Loads a byte array from the given url.
    async fn load_bytes_from_url(&self, url: &str) -> Result<bytes::Bytes, GalileoError>;

    /// Decodes an image from raw byte data
    ///
    /// Raw bytes may contain in any supported format. The list of formats depends on the platform.
    // TODO: LIST the supported formats
    async fn decode_image(&self, imaage_data: Bytes) -> Result<DecodedImage, GalileoError>;
}

#[cfg(not(target_arch = "wasm32"))]
pub mod native;

/// Platform service implementation for the current platform.
#[cfg(not(target_arch = "wasm32"))]
/// Default implementation of the [`PlatformService`] for the current platform.
pub type PlatformServiceImpl = native::NativePlatformService;

#[cfg(target_arch = "wasm32")]
pub mod web;

/// Platform service implementation for the current platform.
#[cfg(target_arch = "wasm32")]
/// Default implementation of the [`PlatformService`] for the current platform.
pub type PlatformServiceImpl = web::WebPlatformService;

lazy_static! {
    static ref SERVICE: PlatformServiceImpl = PlatformServiceImpl::new();
}

/// Returns the singleton instance of the platform service
pub fn instance() -> &'static PlatformServiceImpl {
    &SERVICE
}