gsk4/
color_stop.rs

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
// Take a look at the license at the top of the repository in the LICENSE file.

use std::fmt;

use crate::ffi;
use gdk::RGBA;
use glib::translate::*;

glib::wrapper! {
    /// A color stop in a gradient node.
    #[doc(alias = "GskColorStop")]
    pub struct ColorStop(BoxedInline<ffi::GskColorStop>);
}

impl ColorStop {
    #[inline]
    pub fn new(offset: f32, color: RGBA) -> Self {
        assert_initialized_main_thread!();
        unsafe {
            Self::unsafe_from(ffi::GskColorStop {
                offset,
                color: *color.to_glib_none().0,
            })
        }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`ColorStop`]
    /// objects.
    ///
    /// This method returns an instance of
    /// [`ColorStopBuilder`](crate::builders::ColorStopBuilder) which can be
    /// used to create [`ColorStop`] objects.
    pub fn builder() -> ColorStopBuilder {
        ColorStopBuilder::default()
    }

    #[inline]
    pub fn offset(&self) -> f32 {
        self.inner.offset
    }

    #[inline]
    pub fn color(&self) -> &RGBA {
        unsafe { &*(&self.inner.color as *const gdk::ffi::GdkRGBA as *const RGBA) }
    }
}

impl fmt::Debug for ColorStop {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("ColorStop")
            .field("offset", &self.offset())
            .field("color", &self.color())
            .finish()
    }
}

#[derive(Clone, Default)]
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`ColorStop`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct ColorStopBuilder(Vec<ColorStop>);

impl ColorStopBuilder {
    // rustdoc-stripper-ignore-next
    /// Create a new [`ColorStopBuilder`].
    pub fn new() -> Self {
        Self::default()
    }

    pub fn at(mut self, offset: f32, color: RGBA) -> Self {
        self.0.push(ColorStop::new(offset, color));
        self
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`ColorStop`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> Vec<ColorStop> {
        self.0
    }
}

#[test]
fn color_stop_builder() {
    let t1 = ColorStop::builder()
        .at(0.0, gdk::RGBA::RED)
        .at(0.333, gdk::RGBA::RED)
        .at(0.667, gdk::RGBA::BLUE)
        .at(1.0, gdk::RGBA::RED)
        .build();

    let t2 = &[
        ColorStop::new(0.0, gdk::RGBA::RED),
        ColorStop::new(0.333, gdk::RGBA::RED),
        ColorStop::new(0.667, gdk::RGBA::BLUE),
        ColorStop::new(1.0, gdk::RGBA::RED),
    ];

    assert_eq!(t1.len(), t2.len(), "Arrays don't have the same length");
    assert!(
        &t1.iter()
            .zip(t2.iter())
            .all(|(a, b)| a.offset() == b.offset() && a.color() == b.color()),
        "Arrays are not equal"
    );
}