Skip to main content

mirascript_vm/value/types/
boolean.rs

1use crate::{MiraError, MiraType, Result, Runtime, TryFromMira};
2
3use super::{MiraValue, value::RawValue, value::ValueTag};
4
5impl MiraValue {
6    /// Create a `MiraValue` representing a boolean value.
7    #[inline]
8    pub const fn boolean(value: bool) -> Self {
9        Self::from_raw(RawValue::from_tagged(
10            ValueTag::Boolean,
11            [value as u8, 0, 0, 0, 0, 0],
12        ))
13    }
14
15    /// A `MiraValue` representing the boolean value `true`.
16    pub const TRUE: MiraValue = MiraValue::boolean(true);
17    /// A `MiraValue` representing the boolean value `false`.
18    pub const FALSE: MiraValue = MiraValue::boolean(false);
19
20    /// Check whether this value is a boolean value.
21    #[inline]
22    pub const fn is_boolean(&self) -> bool {
23        matches!(self.value_type(), MiraType::Boolean)
24    }
25
26    /// Return the inline boolean payload, or `None` for another value type.
27    #[inline]
28    pub const fn as_boolean(&self) -> Option<bool> {
29        if self.is_boolean() {
30            Some(self.as_boolean_unchecked())
31        } else {
32            None
33        }
34    }
35
36    /// Return the inline boolean payload.
37    #[inline]
38    pub const fn as_boolean_unchecked(self) -> bool {
39        debug_assert!(self.is_boolean(), "MiraValue is not a boolean");
40        self.raw().payload()[0] != 0
41    }
42}
43
44impl From<bool> for MiraValue {
45    #[inline]
46    fn from(value: bool) -> Self {
47        Self::boolean(value)
48    }
49}
50
51impl TryFrom<MiraValue> for bool {
52    type Error = Box<MiraError>;
53
54    #[inline]
55    fn try_from(value: MiraValue) -> Result<Self> {
56        value
57            .as_boolean()
58            .ok_or_else(|| MiraError::conversion_type("bool", value.value_type()))
59    }
60}
61
62impl TryFromMira<'_> for bool {
63    fn from_mira(_runtime: &Runtime, value: MiraValue) -> Result<Self> {
64        bool::try_from(value)
65    }
66}
67
68#[cfg(test)]
69mod tests {
70    use super::*;
71
72    #[test]
73    fn test_boolean() {
74        let value = MiraValue::boolean(true);
75        assert!(value.is_boolean());
76        assert_eq!(value.as_boolean(), Some(true));
77
78        let value = MiraValue::boolean(false);
79        assert!(value.is_boolean());
80        assert_eq!(value.as_boolean(), Some(false));
81
82        let value = MiraValue::NIL;
83        assert!(!value.is_boolean());
84        assert_eq!(value.as_boolean(), None);
85    }
86
87    #[test]
88    fn test_try_from() {
89        let value = MiraValue::boolean(true);
90        let boolean: bool = value.try_into().unwrap();
91        assert!(boolean);
92
93        let value = MiraValue::NIL;
94        assert!(bool::try_from(value).is_err());
95        assert!(bool::from_mira(&Runtime::new(), value).is_err());
96    }
97}