artichoke_core/
class_registry.rs

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

artichoke_core/
class_registry.rs
