martin 1.16.0

Blazing fast and lightweight tile server with PostGIS, MBTiles, and PMTiles support
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

//! The `Discovery` trait: what a source kind tells the driver should exist.

use std::collections::BTreeMap;

use martin_core::tiles::BoxedSource;

use crate::config::file::{ResolvedProcess, SourceBuildResult, TileSourceWarning};
use crate::reload::SourceProvenance;

/// Per-Source change-detection value. `Opaque` sources only diff on presence, never update.
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
pub enum Version {
    /// An mtime or content hash; a changed value is an in-place update.
    Tracked(u128),
    /// Unversioned (e.g. a blob listing); equal to every other `Opaque`.
    Opaque,
}

/// One `discover()` observation: what should exist now, plus non-fatal findings along the way.
pub struct Discovered<A> {
    /// id -> (version, source arguments)
    pub sources: BTreeMap<String, (Version, A)>,
    /// Non-fatal findings (a misconfigured source, an unreadable path). Abortable at startup, warn-only live.
    pub warnings: Vec<TileSourceWarning>,
}

impl<A> Discovered<A> {
    #[must_use]
    pub const fn new(sources: BTreeMap<String, (Version, A)>) -> Self {
        Self {
            sources,
            warnings: Vec::new(),
        }
    }
}

/// A built source, with anything source-specific the catalog must apply alongside it.
pub struct BuiltSource {
    pub source: BoxedSource,
    /// What `--save-config` needs to write the source back to a config file.
    pub provenance: Option<SourceProvenance>,
    /// Per-source override of the kind's [`Discovery::process`], if the source configures one.
    pub process: Option<ResolvedProcess>,
}

impl From<BoxedSource> for BuiltSource {
    fn from(source: BoxedSource) -> Self {
        Self {
            source,
            provenance: None,
            process: None,
        }
    }
}

/// Enumerates the sources that should exist now, and builds one on demand.
pub trait Discovery: Send + Sync + 'static {
    /// Per-source build payload passed from [`discover`](Self::discover) to [`build`](Self::build).
    type Args: Clone + Send + Sync + 'static;

    /// Cheap snapshot of id -> (version, source arguments); an `Err` makes the driver retain its baseline.
    fn discover(&self) -> impl Future<Output = SourceBuildResult<Discovered<Self::Args>>> + Send;

    /// Builds one source; an `Err` rides into that source's `NewSource`.
    fn build(
        &self,
        id: &str,
        args: &Self::Args,
    ) -> impl Future<Output = SourceBuildResult<BuiltSource>> + Send;

    /// `ResolvedProcess` stamped onto every source this kind emits.
    fn process(&self) -> ResolvedProcess;

    /// Findings from constructing this discovery, reported once through `init()`.
    fn construction_warnings(&self) -> Vec<TileSourceWarning> {
        Vec::new()
    }
}