artichoke_core/
module_registry.rs

1//! Define and store module specs on an interpreter.
2
3use core::any::Any;
4
5/// Define and store module specs on an interpreter.
6///
7/// A module spec is a static set of information the interpreter requires to
8/// define a Ruby `Module` object.
9pub trait ModuleRegistry {
10    /// Concrete value type for boxed Ruby values.
11    type Value;
12
13    /// Concrete error type for errors encountered when manipulating the module registry.
14    type Error;
15
16    /// Type representing a module specification.
17    type Spec: 'static;
18
19    /// Create a module definition bound to a Rust type `T`.
20    ///
21    /// Module definitions have the same lifetime as the interpreter.
22    ///
23    /// # Errors
24    ///
25    /// If the module registry state is inaccessible, an error is returned.
26    fn def_module<T>(&mut self, spec: Self::Spec) -> Result<(), Self::Error>
27    where
28        T: Any;
29
30    /// Retrieve a module definition from the interpreter bound to Rust type `T`.
31    ///
32    /// This function returns `None` if type `T` has not had a module spec
33    /// registered for it using [`ModuleRegistry::def_module`].
34    ///
35    /// # Errors
36    ///
37    /// If the module registry state is inaccessible, an error is returned.
38    fn module_spec<T>(&self) -> Result<Option<&Self::Spec>, Self::Error>
39    where
40        T: Any;
41
42    /// Retrieve whether a module definition exists from the interpreter bound
43    /// to Rust type `T`
44    ///
45    /// If the interpreter cannot find or load a module associated with `T`,
46    /// `Ok(None)` is returned.
47    ///
48    /// # Errors
49    ///
50    /// If the module registry state is inaccessible, an error is returned.
51    fn is_module_defined<T>(&self) -> bool
52    where
53        T: Any,
54    {
55        matches!(self.module_spec::<T>(), Ok(Some(_)))
56    }
57
58    /// Retrieve a boxed Ruby value containing a `Module` object for the
59    /// `Module` bound to Rust type `T`.
60    ///
61    /// If the interpreter cannot find or load a module associated with `T`,
62    /// `Ok(None)` is returned.
63    ///
64    /// # Errors
65    ///
66    /// If the module registry state is inaccessible, an error is returned.
67    fn module_of<T>(&mut self) -> Result<Option<Self::Value>, Self::Error>
68    where
69        T: Any;
70}
artichoke_core/module_registry.rs

artichoke_core/
module_registry.rs
