artichoke_core/
constant.rs

1//! Define constants on an interpreter.
2//!
3//! Constants can be an arbitrary Ruby value. Constants can be defined globally,
4//! on a class, or on a module.
5
6use crate::value::Value;
7
8/// Define constants on an interpreter.
9///
10/// Constants can be an arbitrary Ruby value. Constants can be defined globally,
11/// on a class, or on a module.
12pub trait DefineConstant {
13    /// Concrete type for Ruby values.
14    type Value: Value;
15
16    /// Concrete error type for fallible operations.
17    type Error;
18
19    /// Define a global constant.
20    ///
21    /// # Errors
22    ///
23    /// If the given constant name is not valid, an error is returned.
24    ///
25    /// If the interpreter cannot define the constant, an error is returned.
26    fn define_global_constant(&mut self, constant: &str, value: Self::Value) -> Result<(), Self::Error>;
27
28    /// Define a class constant.
29    ///
30    /// The class is specified by the type parameter `T`.
31    ///
32    /// # Errors
33    ///
34    /// If the class named by type `T` is not defined, an error is returned.
35    ///
36    /// If the given constant name is not valid, an error is returned.
37    ///
38    /// If the interpreter cannot define the constant, an error is returned.
39    fn define_class_constant<T>(&mut self, constant: &str, value: Self::Value) -> Result<(), Self::Error>
40    where
41        T: 'static;
42
43    /// Define a module constant.
44    ///
45    /// The class is specified by the type parameter `T`.
46    ///
47    /// # Errors
48    ///
49    /// If the module named by type `T` is not defined, an error is returned.
50    ///
51    /// If the given constant name is not valid, an error is returned.
52    ///
53    /// If the interpreter cannot define the constant, an error is returned.
54    fn define_module_constant<T>(&mut self, constant: &str, value: Self::Value) -> Result<(), Self::Error>
55    where
56        T: 'static;
57}
artichoke_core/constant.rs

artichoke_core/
constant.rs
