matrix-rain 0.3.0

Classic Matrix digital rain effect as a ratatui widget (no_std-capable) and standalone TUI binary.
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

//! Error types returned by the builder and config validation.

use alloc::string::String;

use thiserror::Error;

/// Errors produced by [`MatrixConfigBuilder::build`](crate::MatrixConfigBuilder::build)
/// and related validation routines.
#[derive(Debug, Error)]
pub enum MatrixError {
    /// A configuration value failed its invariant check (e.g. `fps < 1`,
    /// non-finite `speed`, `density` outside `[0.0, 1.0]`, `min_trail > max_trail`).
    /// The string carries a human-readable description of which field and why.
    #[error("invalid configuration: {0}")]
    InvalidConfig(/// Reason the config was rejected.
        String),

    /// The configured [`CharSet`](crate::CharSet) resolves to zero glyphs.
    /// Only [`CharSet::Custom`](crate::CharSet::Custom) with an empty `Vec`
    /// can hit this — the built-in variants always resolve to non-empty
    /// lists.
    #[error("empty character set")]
    EmptyCharset,
}

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

    #[test]
    fn invalid_config_renders_message() {
        let e = MatrixError::InvalidConfig("fps must be >= 1".into());
        assert_eq!(e.to_string(), "invalid configuration: fps must be >= 1");
    }

    #[test]
    fn empty_charset_renders_message() {
        assert_eq!(MatrixError::EmptyCharset.to_string(), "empty character set");
    }
}