ratatui-splash-screen 0.1.5

A Ratatui widget to turn any image to a splash screen in your terminal
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

use crate::SplashError;

/// Splash screen configuration.
#[derive(Clone, Copy, Debug)]
pub struct SplashConfig<'a> {
    /// Image data.
    pub image_data: &'a [u8],
    /// SHA256sum of the file.
    pub sha256sum: Option<&'a str>,
    /// Number of the rendering steps.
    pub render_steps: i32,
    /// Whether to use colors.
    pub use_colors: bool,
}

impl<'a> SplashConfig<'a> {
    /// Constructs a new instance.
    pub fn new(
        image_data: &'a [u8],
        sha256sum: Option<&'a str>,
        render_steps: i32,
        use_colors: bool,
    ) -> Self {
        Self {
            image_data,
            sha256sum,
            render_steps,
            use_colors,
        }
    }

    /// Verifies the SHA256 checksum and returns an error on mismatch.
    pub fn verify_checksum(&self) -> Result<(), SplashError> {
        if let Some(sha256sum) = self.sha256sum {
            let data_sha256sum = self.data_sha256sum();
            if sha256sum != data_sha256sum {
                return Err(SplashError {
                    message: format!(
                        "splash screen asset could not be verified\n({sha256sum} != {data_sha256sum})",
                    ),
                });
            }
        }

        Ok(())
    }

    /// Returns the SHA256 digest of the image data.
    fn data_sha256sum(&self) -> String {
        sha256::digest(self.image_data)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_verify_sha256sum() -> Result<(), SplashError> {
        let config = SplashConfig {
            image_data: include_bytes!("../assets/splash.png"),
            sha256sum: Some("abc7e993ae85580df6a1349e89aa57d7d39cecdfe3cd5cc95f65b730aafab2cb"),
            render_steps: 0,
            use_colors: false,
        };
        assert!(config.verify_checksum().is_ok());

        let config = SplashConfig {
            image_data: include_bytes!("../assets/splash.png"),
            sha256sum: Some("test"),
            render_steps: 0,
            use_colors: false,
        };
        assert!(config.verify_checksum().is_err());

        let config = SplashConfig {
            image_data: &[],
            sha256sum: None,
            render_steps: 0,
            use_colors: false,
        };
        assert!(config.verify_checksum().is_ok());

        Ok(())
    }
}