pride-overlay 3.0.0

overlay pride flags on images
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

use crate::Colour;

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

mod data;
pub use data::PresetFlag;

mod svg;
pub use svg::{Svg, SvgData, SvgScaleMode};

/// Get information about a pride flag.
pub trait FlagData {
    fn name(&self) -> &str;
    fn colours(&self) -> &[Colour];
    fn svg(&self) -> Option<&dyn SvgData>;
}

/// A pride flag.
#[derive(bon::Builder, Clone, Copy, Default)]
#[builder(
    const,
    builder_type(doc {
        /// Builder for the [Flag] struct.
    })
)]
pub struct Flag<'a> {
    #[builder(start_fn)]
    /// Name of the flag.
    pub(crate) name: &'a str,
    /// Colours that make up the flag.
    #[builder(start_fn)]
    pub(crate) colours: &'a [Colour],
    /// Optional SVG representation of the flag.
    pub(crate) svg: Option<svg::Svg<'a>>,
}

impl<'a> FlagData for Flag<'a> {
    fn name(&self) -> &str {
        self.name
    }

    fn colours(&self) -> &[Colour] {
        self.colours
    }

    fn svg(&self) -> Option<&dyn SvgData> {
        self.svg.as_ref().map(|svg| svg as &dyn SvgData)
    }
}