oy 0.1.0

Oy makes your application's structs and functions interactive
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283

use core::any::type_name;
use core::fmt::Debug;

use crate::specialization::{AsDebug, AsMethods, AsMethodsMut};
use crate::{InteractiveError, Result};

/// A trait that gives interactive access to its fields as `dyn Interactive` or `dyn Debug`.
///
/// This trait gets implemented automatically when you derive it with [`Interactive`].
/// See the macros documentation for more information.
///
/// [`Interactive`]: macro@crate::Interactive
pub trait Interactive: AsDebug + AsMethods + AsMethodsMut {
    /// Looks for a field with the given name and on success return a shared reference to it.
    fn get_field<'a>(&'a self, field_name: &'a str) -> crate::Result<'a, &dyn crate::Interactive> {
        Err(InteractiveError::FieldNotFound {
            type_name: type_name::<Self>(),
            field_name,
        })
    }

    /// Looks for a field with the given name and on success return a mutable reference to it.
    fn get_field_mut<'a>(
        &'a mut self,
        field_name: &'a str,
    ) -> crate::Result<'a, &mut dyn crate::Interactive> {
        Err(InteractiveError::FieldNotFound {
            type_name: type_name::<Self>(),
            field_name,
        })
    }

    /// Looks for a field with the given name,
    /// and passes it as a `Ok(&dyn Debug)` to the given closure.
    ///
    /// On error the `Err(InteractiveError)` is passed to the closure instead.
    fn eval_field(&self, field_name: &str, f: &mut dyn FnMut(Result<'_, &dyn Debug>)) {
        f(Err(InteractiveError::FieldNotFound {
            type_name: type_name::<Self>(),
            field_name,
        }))
    }

    /// Returns all interactive field names of this type.
    ///
    /// Can be used to drive auto-completion in a CLI.
    fn get_all_field_names(&self) -> &'static [&'static str] {
        &[]
    }
}

/// A trait that allows to interactively evaluate a structs methods and pass their result to the given closure.
///
/// This trait gets implemented automatically when you use the [`Methods`] attribute.
/// See its documentation for more information.
///
/// [`Interactive`]: macro@crate::Interactive
/// [`Methods`]: macro@crate::Methods
pub trait Methods {
    /// Looks for a method with the given name,
    /// parses the args string into the expected arguments of the method,
    /// executes the method and
    /// passes the result as a `Ok(&dyn Debug)` to the given closure.
    ///
    /// On error the `Err(InteractiveError)` is passed to the closure instead.
    ///
    /// This method does not have access to methods that take `&mut self` as their receiver,
    /// use [`eval_method_mut`] instead.
    ///
    /// [`eval_method_mut`]: #method.eval_method_mut
    fn eval_method(
        &self,
        method_name: &str,
        args: &str,
        f: &mut dyn FnMut(Result<'_, &dyn Debug>),
    ) {
        {
            let _ = args;
            f(Err(InteractiveError::MethodNotFound {
                type_name: type_name::<Self>(),
                method_name,
            }));
        }
    }

    /// Looks for a method with the given name,
    /// parses the args string into the expected arguments of the method,
    /// executes the method and
    /// passes the result as a `Ok(&dyn Debug)` to the given closure.
    ///
    /// On error the `Err(InteractiveError)` is passed to the closure instead.
    fn eval_method_mut(
        &mut self,
        method_name: &str,
        args: &str,
        f: &mut dyn FnMut(Result<'_, &dyn Debug>),
    ) {
        let _ = args;
        f(Err(InteractiveError::MethodNotFound {
            type_name: type_name::<Self>(),
            method_name,
        }));
    }

    /// Returns all interactive method names of this type.
    ///
    /// Can be used to drive auto-completion in a CLI.
    fn get_all_method_names(&self) -> &'static [&'static str] {
        &[]
    }
}

// TODO remove after https://github.com/auto-impl-rs/auto_impl/pull/73 gets merged
impl<'b, T: 'b + Interactive + ?::core::marker::Sized> Interactive for &'b T
where
    &'b T: AsDebug + AsMethods + AsMethodsMut,
{
    fn get_field<'a>(&'a self, field_name: &'a str) -> crate::Result<'a, &dyn crate::Interactive> {
        T::get_field(self, field_name)
    }
    fn eval_field(&self, field_name: &str, f: &mut dyn FnMut(Result<'_, &dyn Debug>)) {
        T::eval_field(self, field_name, f)
    }
    fn get_all_field_names(&self) -> &'static [&'static str] {
        T::get_all_field_names(self)
    }
}
impl<'b, T: 'b + Interactive + ?::core::marker::Sized> Interactive for &'b mut T
where
    &'b mut T: AsDebug + AsMethods + AsMethodsMut,
{
    fn get_field<'a>(&'a self, field_name: &'a str) -> crate::Result<'a, &dyn crate::Interactive> {
        T::get_field(self, field_name)
    }
    fn get_field_mut<'a>(
        &'a mut self,
        field_name: &'a str,
    ) -> crate::Result<'a, &mut dyn crate::Interactive> {
        T::get_field_mut(self, field_name)
    }
    fn eval_field(&self, field_name: &str, f: &mut dyn FnMut(Result<'_, &dyn Debug>)) {
        T::eval_field(self, field_name, f)
    }
    fn get_all_field_names(&self) -> &'static [&'static str] {
        T::get_all_field_names(self)
    }
}
#[cfg(feature = "std")]
impl<T: Interactive + ?::std::marker::Sized> Interactive for ::std::boxed::Box<T>
where
    ::std::boxed::Box<T>: AsDebug + AsMethods + AsMethodsMut,
{
    fn get_field<'a>(&'a self, field_name: &'a str) -> crate::Result<'a, &dyn crate::Interactive> {
        T::get_field(self, field_name)
    }
    fn get_field_mut<'a>(
        &'a mut self,
        field_name: &'a str,
    ) -> crate::Result<'a, &mut dyn crate::Interactive> {
        T::get_field_mut(self, field_name)
    }
    fn eval_field(&self, field_name: &str, f: &mut dyn FnMut(Result<'_, &dyn Debug>)) {
        T::eval_field(self, field_name, f)
    }
    fn get_all_field_names(&self) -> &'static [&'static str] {
        T::get_all_field_names(self)
    }
}
#[cfg(feature = "std")]
impl<T: Interactive + ?::std::marker::Sized> Interactive for ::std::rc::Rc<T>
where
    ::std::rc::Rc<T>: AsDebug + AsMethods + AsMethodsMut,
{
    fn get_field<'a>(&'a self, field_name: &'a str) -> crate::Result<'a, &dyn crate::Interactive> {
        T::get_field(self, field_name)
    }
    fn eval_field(&self, field_name: &str, f: &mut dyn FnMut(Result<'_, &dyn Debug>)) {
        T::eval_field(self, field_name, f)
    }
    fn get_all_field_names(&self) -> &'static [&'static str] {
        T::get_all_field_names(self)
    }
}
#[cfg(feature = "std")]
impl<T: Interactive + ?::std::marker::Sized> Interactive for ::std::sync::Arc<T>
where
    ::std::sync::Arc<T>: AsDebug + AsMethods + AsMethodsMut,
{
    fn get_field<'a>(&'a self, field_name: &'a str) -> crate::Result<'a, &dyn crate::Interactive> {
        T::get_field(self, field_name)
    }
    fn eval_field(&self, field_name: &str, f: &mut dyn FnMut(Result<'_, &dyn Debug>)) {
        T::eval_field(self, field_name, f)
    }
    fn get_all_field_names(&self) -> &'static [&'static str] {
        T::get_all_field_names(self)
    }
}

impl<'a, T: 'a + Methods + ?::core::marker::Sized> Methods for &'a T {
    fn eval_method(
        &self,
        method_name: &str,
        args: &str,
        f: &mut dyn FnMut(Result<'_, &dyn Debug>),
    ) {
        T::eval_method(self, method_name, args, f)
    }
    fn get_all_method_names(&self) -> &'static [&'static str] {
        T::get_all_method_names(self)
    }
}
impl<'a, T: 'a + Methods + ?::core::marker::Sized> Methods for &'a mut T {
    fn eval_method(
        &self,
        method_name: &str,
        args: &str,
        f: &mut dyn FnMut(Result<'_, &dyn Debug>),
    ) {
        T::eval_method(self, method_name, args, f)
    }
    fn eval_method_mut(
        &mut self,
        method_name: &str,
        args: &str,
        f: &mut dyn FnMut(Result<'_, &dyn Debug>),
    ) {
        T::eval_method_mut(self, method_name, args, f)
    }
    fn get_all_method_names(&self) -> &'static [&'static str] {
        T::get_all_method_names(self)
    }
}
#[cfg(feature = "std")]
impl<T: Methods + ?::std::marker::Sized> Methods for ::std::boxed::Box<T> {
    fn eval_method(
        &self,
        method_name: &str,
        args: &str,
        f: &mut dyn FnMut(Result<'_, &dyn Debug>),
    ) {
        T::eval_method(self, method_name, args, f)
    }
    fn eval_method_mut(
        &mut self,
        method_name: &str,
        args: &str,
        f: &mut dyn FnMut(Result<'_, &dyn Debug>),
    ) {
        T::eval_method_mut(self, method_name, args, f)
    }
    fn get_all_method_names(&self) -> &'static [&'static str] {
        T::get_all_method_names(self)
    }
}
#[cfg(feature = "std")]
impl<T: Methods + ?::std::marker::Sized> Methods for ::std::rc::Rc<T> {
    fn eval_method(
        &self,
        method_name: &str,
        args: &str,
        f: &mut dyn FnMut(Result<'_, &dyn Debug>),
    ) {
        T::eval_method(self, method_name, args, f)
    }
    fn get_all_method_names(&self) -> &'static [&'static str] {
        T::get_all_method_names(self)
    }
}
#[cfg(feature = "std")]
impl<T: Methods + ?::std::marker::Sized> Methods for ::std::sync::Arc<T> {
    fn eval_method(
        &self,
        method_name: &str,
        args: &str,
        f: &mut dyn FnMut(Result<'_, &dyn Debug>),
    ) {
        T::eval_method(self, method_name, args, f)
    }
    fn get_all_method_names(&self) -> &'static [&'static str] {
        T::get_all_method_names(self)
    }
}