rhai-sdk-common-utils 0.1.0

Common utilities shared across REX Rhai SDK crates
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 rhai::Dynamic;
use rhai::plugin::{
    FnNamespace, FuncRegistration, Module, NativeCallContext, PluginFunc, RhaiResult, TypeId,
    export_module, mem,
};

/// [`std::time::Duration`] module for Rhai
#[export_module]
pub mod duration_module {
    use std::time::Duration as StdDuration;

    pub type Duration = StdDuration;

    /// Create a new Duration from a number of seconds.
    ///
    /// If a negative duration is provided, a duration of
    /// 0 seconds will be used.
    #[rhai_fn(global)]
    pub fn from_secs(secs: i64) -> Duration {
        Duration::from_secs(secs.try_into().unwrap_or(0))
    }
}

#[cfg(test)]
mod tests {
    use rex_test_utils::rhai::common::create_test_engine_and_register;
    use rstest::rstest;
    use std::time::Duration;

    /// Given: A number of seconds
    /// When: Calling from_secs with that value in Rhai
    /// Then: A Duration with the correct seconds value should be created
    #[rstest]
    #[case(0, "zero seconds")]
    #[case(1, "one second")]
    #[case(60, "one minute")]
    #[case(3600, "one hour")]
    #[case(86400, "one day")]
    fn test_from_secs(#[case] secs: u64, #[case] description: &str) {
        let engine = create_test_engine_and_register();
        let script = format!("from_secs({})", secs);
        let result = engine.eval::<Duration>(&script).unwrap();
        assert_eq!(
            result,
            Duration::from_secs(secs),
            "Failed for: {}",
            description
        );
    }
}