artichoke_core/
convert.rs

1//! Convert between Rust and Ruby objects.
2
3/// Infallible conversion between two types.
4///
5/// Implementers may not allocate on the interpreter heap.
6///
7/// See [`core::convert::From`].
8/// See [`ConvertMut`].
9pub trait Convert<T, U> {
10    /// Performs the infallible conversion.
11    fn convert(&self, from: T) -> U;
12}
13
14/// Fallible conversions between two types.
15///
16/// Implementers may not allocate on the interpreter heap.
17///
18/// See [`core::convert::TryFrom`].
19/// See [`TryConvertMut`].
20pub trait TryConvert<T, U> {
21    /// Error type for failed conversions.
22    type Error;
23
24    /// Performs the fallible conversion.
25    ///
26    /// # Errors
27    ///
28    /// If boxing or unboxing a value into the specified type fails, an error is
29    /// returned.
30    fn try_convert(&self, value: T) -> Result<U, Self::Error>;
31}
32
33/// Mutable infallible conversion between two types.
34///
35/// Implementers may allocate on the interpreter heap.
36///
37/// See [`core::convert::From`].
38/// See [`Convert`].
39pub trait ConvertMut<T, U> {
40    /// Performs the infallible conversion.
41    fn convert_mut(&mut self, from: T) -> U;
42}
43
44/// Mutable fallible conversions between two types.
45///
46/// Implementers may allocate on the interpreter heap.
47///
48/// See [`core::convert::TryFrom`].
49/// See [`TryConvert`].
50pub trait TryConvertMut<T, U> {
51    /// Error type for failed conversions.
52    type Error;
53
54    /// Performs the fallible conversion.
55    ///
56    /// # Errors
57    ///
58    /// If boxing or unboxing a value into the specified type fails, an error is
59    /// returned.
60    fn try_convert_mut(&mut self, value: T) -> Result<U, Self::Error>;
61}
artichoke_core/convert.rs

artichoke_core/
convert.rs
