artichoke_backend/
globals.rs

1use std::borrow::Cow;
2
3use crate::Artichoke;
4use crate::core::{Globals, Intern};
5use crate::error::Error;
6use crate::sys;
7use crate::value::Value;
8
9// TODO: Handle invalid variable names. For now this is delegated to mruby.
10// The parser in `spinoso-symbol` can handle this.
11
12impl Globals for Artichoke {
13    type Value = Value;
14
15    type Error = Error;
16
17    fn set_global_variable<T>(&mut self, name: T, value: &Self::Value) -> Result<(), Self::Error>
18    where
19        T: Into<Cow<'static, [u8]>>,
20    {
21        let sym = self.intern_bytes(name.into())?;
22        unsafe {
23            self.with_ffi_boundary(|mrb| sys::mrb_gv_set(mrb, sym, value.inner()))?;
24        }
25        Ok(())
26    }
27
28    /// Unset global variable pointed to by `name`.
29    ///
30    /// Unsetting a global variable removes the name from the global storage
31    /// table. Unset globals resolve to `nil` in the Ruby VM.
32    ///
33    /// Unsetting a global that is currently unset is a no-op.
34    ///
35    /// # Errors
36    ///
37    /// If the name is not a valid global name, an error is returned.
38    fn unset_global_variable<T>(&mut self, name: T) -> Result<(), Self::Error>
39    where
40        T: Into<Cow<'static, [u8]>>,
41    {
42        let sym = self.intern_bytes(name.into())?;
43        let nil = Value::nil();
44        unsafe {
45            self.with_ffi_boundary(|mrb| sys::mrb_gv_set(mrb, sym, nil.inner()))?;
46        }
47        Ok(())
48    }
49
50    fn get_global_variable<T>(&mut self, name: T) -> Result<Option<Self::Value>, Self::Error>
51    where
52        T: Into<Cow<'static, [u8]>>,
53    {
54        let sym = self.intern_bytes(name.into())?;
55        let value = unsafe { self.with_ffi_boundary(|mrb| sys::mrb_gv_get(mrb, sym))? };
56        // NOTE: This implementation is not compliant with the spec laid out in
57        // the trait documentation. This implementation always returns `Some(_)`
58        // even if the global is unset.
59        Ok(Some(Value::from(value)))
60    }
61}
artichoke_backend/globals.rs

artichoke_backend/
globals.rs
