Skip to main content

mirascript_vm/value/types/
value.rs

1use crate::{MiraType, value::arena::MiraHandle};
2
3use super::{MiraArray, MiraExtern, MiraFunction, MiraModule, MiraRecord};
4
5/// A compact value understood by the Rust VM.
6///
7/// Scalar payloads are stored inline. Runtime-owned payloads are represented by
8/// checked handles into a [`crate::Runtime`] arena.
9#[derive(Clone, Copy, Debug, Default, PartialEq)]
10pub enum MiraValue {
11    /// The MiraScript `nil` value.
12    #[default]
13    Nil,
14    /// A boolean value.
15    Boolean(bool),
16    /// A double-precision numeric value.
17    Number(f64),
18    /// A compile-time static UTF-8 string stored as a thin pointer.
19    StaticStr(&'static &'static str),
20    /// A runtime-owned UTF-8 string.
21    String(MiraHandle<String>),
22    /// A MiraScript array.
23    Array(MiraHandle<dyn MiraArray>),
24    /// A MiraScript record.
25    Record(MiraHandle<dyn MiraRecord>),
26    /// A MiraScript function.
27    Function(MiraHandle<dyn MiraFunction>),
28    /// A MiraScript module.
29    Module(MiraHandle<dyn MiraModule>),
30    /// Reserved external value placeholder.
31    #[doc(hidden)]
32    Extern(MiraHandle<dyn MiraExtern>),
33}
34
35const _: () = assert!(std::mem::size_of::<MiraValue>() == 16);
36const _: () = assert!(std::mem::size_of::<Option<MiraValue>>() == 16);
37
38impl MiraValue {
39    /// Return this value's MiraScript category.
40    #[inline]
41    pub const fn value_type(self) -> MiraType {
42        match self {
43            Self::Nil => MiraType::Nil,
44            Self::Boolean(_) => MiraType::Boolean,
45            Self::Number(_) => MiraType::Number,
46            Self::StaticStr(_) | Self::String(_) => MiraType::String,
47            Self::Array(_) => MiraType::Array,
48            Self::Record(_) => MiraType::Record,
49            Self::Function(_) => MiraType::Function,
50            Self::Module(_) => MiraType::Module,
51            Self::Extern(_) => MiraType::Extern,
52        }
53    }
54
55    /// Return the MiraScript type name for this value.
56    #[inline]
57    pub const fn type_name(self) -> &'static str {
58        self.value_type().name()
59    }
60}