snapr 0.7.1

Library enabling a flexible and frictionless way to render snapshots of maps with overlayed geometries.
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

use std::fmt;

use macros::impl_snapr_builder;

use crate::{Error, Snapr, TileFetcher, Zoom};

pub(crate) mod macros {
    macro_rules! impl_snapr_builder {
        (($builder_ty: ty, $builder_ident: ident), ($snapr_ty: ty, $snapr_ident: ident), ($tile_fetcher_ty: ty, $tile_fetcher_ident: ident)) => {
            impl<'a> $builder_ty {
                #[doc = concat!("Constructs a new [`", stringify!($builder_ident), "`] to be used in constructing a [`", stringify!($snapr_ident), "`].")]
                pub fn new() -> Self {
                    Self::default()
                }

                #[doc = concat!("Configures a [`", stringify!($tile_fetcher_ident), "`] to be used in the [`", stringify!($snapr_ident), "::tile_fetcher`] field.")]
                pub fn with_tile_fetcher(self, tile_fetcher: $tile_fetcher_ty) -> Self {
                    Self {
                        tile_fetcher: Some(tile_fetcher),
                        ..self
                    }
                }

                #[doc = concat!("Configures the `tile_size` to be used in the [`", stringify!($snapr_ident), "::tile_size`] field.")]
                pub fn with_tile_size(self, tile_size: u32) -> Self {
                    Self {
                        tile_size: Some(tile_size),
                        ..self
                    }
                }

                #[doc = concat!("Configures the `height` to be used in the [`", stringify!($snapr_ident), "::height`] field.")]
                pub fn with_height(self, height: u32) -> Self {
                    Self {
                        height: Some(height),
                        ..self
                    }
                }

                #[doc = concat!("Configures the `width` to be used in the [`", stringify!($snapr_ident), "::width`] field.")]
                pub fn with_width(self, width: u32) -> Self {
                    Self {
                        width: Some(width),
                        ..self
                    }
                }

                #[doc = concat!("Configures the `zoom` to be used in the [`", stringify!($snapr_ident), "::zoom`] field.")]
                pub fn with_zoom<Z: Into<Zoom>>(self, zoom: Z) -> Self {
                    Self {
                        zoom: Some(zoom.into()),
                        ..self
                    }
                }
            }
        };
    }

    pub(crate) use impl_snapr_builder;
}

/// Builder structure for [`Snapr`].
///
/// ## Example
///
/// ```rust
/// use image::DynamicImage;
/// use snapr::{SnaprBuilder, TileFetcher};
///
/// fn tile_fetcher(x: i32, y: i32, zoom: u8) -> Result<DynamicImage, snapr::Error> {
///     todo!()
/// }
///
/// let snapr = SnaprBuilder::new()
///     .with_tile_fetcher(TileFetcher::individual(tile_fetcher))
///     .build();
///
/// assert!(snapr.is_ok());
/// ```
#[derive(Default)]
pub struct SnaprBuilder<'a> {
    tile_fetcher: Option<TileFetcher<'a>>,
    tile_size: Option<u32>,
    height: Option<u32>,
    width: Option<u32>,
    zoom: Option<Zoom>,
}

impl<'a> SnaprBuilder<'a> {
    /// Attempts to construct a new [`Snapr`] from the [`SnaprBuilder`].
    ///
    /// ## Example
    ///
    /// ```rust
    /// use image::DynamicImage;
    /// use snapr::{SnaprBuilder, TileFetcher};
    ///
    /// fn tile_fetcher(x: i32, y: i32, zoom: u8) -> Result<DynamicImage, snapr::Error> {
    ///     todo!()
    /// }
    ///
    /// let snapr = SnaprBuilder::new()
    ///     .with_tile_fetcher(TileFetcher::individual(tile_fetcher))
    ///     .build();
    ///
    /// assert!(snapr.is_ok());
    /// ```
    pub fn build(self) -> Result<Snapr<'a>, Error> {
        let Some(tile_fetcher) = self.tile_fetcher else {
            return Err(Error::Builder {
                reason: "field `tile_fetcher` needs to be set prior to a `snapr` being built"
                    .to_string(),
            });
        };

        let tile_size = self.tile_size.unwrap_or(256);
        let height = self.height.unwrap_or(600);
        let width = self.width.unwrap_or(800);
        let zoom = self.zoom.unwrap_or_default();

        let snapr = Snapr {
            tile_fetcher,
            tile_size,
            height,
            width,
            zoom,
        };

        Ok(snapr)
    }
}

impl_snapr_builder!(
    (SnaprBuilder<'a>, SnaprBuilder),
    (Snapr<'a>, Snapr),
    (TileFetcher<'a>, TileFetcher)
);

impl<'a> fmt::Debug for SnaprBuilder<'a> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("SnaprBuilder")
            .field("tile_size", &self.tile_size)
            .field("height", &self.height)
            .field("width", &self.width)
            .field("zoom", &self.zoom)
            .finish()
    }
}