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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
use core::cmp::Ordering;
use core::fmt;
use core::ops;
use crate as rune;
use crate::alloc::clone::TryClone;
use crate::runtime::{
EnvProtocolCaller, FromValue, Inline, ProtocolCaller, Repr, RuntimeError, ToValue, Value,
VmErrorKind, VmResult,
};
use crate::Any;
use super::StepsBetween;
/// Type for a range expression `start..end`.
///
/// # Examples
///
/// ```rune
/// let range = 0..10;
/// assert!(!range.contains(-10));
/// assert!(range.contains(5));
/// assert!(!range.contains(10));
/// assert!(!range.contains(20));
///
/// assert!(range is std::ops::Range);
/// ```
///
/// Ranges can contain any type:
///
/// ```rune
/// let range = 'a'..'f';
/// assert_eq!(range.start, 'a');
/// range.start = 'b';
/// assert_eq!(range.start, 'b');
/// assert_eq!(range.end, 'f');
/// range.end = 'g';
/// assert_eq!(range.end, 'g');
/// ```
///
/// Certain ranges can be used as iterators:
///
/// ```rune
/// let range = 'a'..'e';
/// assert_eq!(range.iter().collect::<Vec>(), ['a', 'b', 'c', 'd']);
/// ```
///
/// # Examples
///
/// ```rust
/// use rune::runtime::Range;
///
/// let start = rune::to_value(1)?;
/// let end = rune::to_value(10)?;
/// let _ = Range::new(start, end);
/// # Ok::<_, rune::support::Error>(())
/// ```
#[derive(Any, Clone, TryClone)]
#[try_clone(crate)]
#[rune(crate, constructor, item = ::std::ops)]
pub struct Range {
/// The start value of the range.
#[rune(get, set)]
pub start: Value,
/// The to value of the range.
#[rune(get, set)]
pub end: Value,
}
impl Range {
/// Construct a new range.
pub fn new(start: Value, end: Value) -> Self {
Self { start, end }
}
/// Iterate over the range.
///
/// # Panics
///
/// This panics if the range is not a well-defined range.
///
/// # Examples
///
/// ```rune
/// let range = 'a'..'e';
/// assert_eq!(range.iter().collect::<Vec>(), ['a', 'b', 'c', 'd']);
/// ```
///
/// Cannot construct an iterator over floats:
///
/// ```rune,should_panic
/// let range = 1.0..2.0;
/// range.iter()
/// ```
#[rune::function(keep)]
pub fn iter(&self) -> VmResult<Value> {
let value = match (self.start.as_ref(), self.end.as_ref()) {
(Repr::Inline(Inline::Unsigned(start)), Repr::Inline(end)) => {
let end = vm_try!(end.as_integer::<u64>());
vm_try!(rune::to_value(RangeIter::new(*start..end)))
}
(Repr::Inline(Inline::Signed(start)), Repr::Inline(end)) => {
let end = vm_try!(end.as_integer::<i64>());
vm_try!(rune::to_value(RangeIter::new(*start..end)))
}
(Repr::Inline(Inline::Char(start)), Repr::Inline(Inline::Char(end))) => {
vm_try!(rune::to_value(RangeIter::new(*start..*end)))
}
(start, end) => {
return VmResult::err(VmErrorKind::UnsupportedIterRange {
start: start.type_info(),
end: end.type_info(),
})
}
};
VmResult::Ok(value)
}
/// Iterate over the range.
///
/// # Panics
///
/// This panics if the range is not a well-defined range.
///
/// # Examples
///
/// ```rune
/// let vec = [];
///
/// for value in 'a'..'e' {
/// vec.push(value);
/// }
///
/// assert_eq!(vec, ['a', 'b', 'c', 'd']);
/// ```
///
/// Cannot construct an iterator over floats:
///
/// ```rune,should_panic
/// for value in 1.0..2.0 {
/// }
/// ```
#[rune::function(keep, protocol = INTO_ITER)]
pub fn into_iter(&self) -> VmResult<Value> {
self.iter()
}
/// Test the range for partial equality.
///
/// # Examples
///
/// ```rune
/// let range = 'a'..'e';
/// assert!(range == ('a'..'e'));
/// assert!(range != ('b'..'e'));
///
/// let range = 1.0..2.0;
/// assert!(range == (1.0..2.0));
/// assert!(range != (f64::NAN..2.0));
/// assert!((f64::NAN..2.0) != (f64::NAN..2.0));
/// ```
#[rune::function(keep, protocol = PARTIAL_EQ)]
pub fn partial_eq(&self, other: &Self) -> VmResult<bool> {
self.partial_eq_with(other, &mut EnvProtocolCaller)
}
pub(crate) fn partial_eq_with(
&self,
b: &Self,
caller: &mut dyn ProtocolCaller,
) -> VmResult<bool> {
if !vm_try!(Value::partial_eq_with(&self.start, &b.start, caller)) {
return VmResult::Ok(false);
}
Value::partial_eq_with(&self.end, &b.end, caller)
}
/// Test the range for total equality.
///
/// # Examples
///
/// ```rune
/// use std::ops::eq;
///
/// let range = 'a'..'e';
/// assert!(eq(range, 'a'..'e'));
/// assert!(!eq(range, 'b'..'e'));
/// ```
#[rune::function(keep, protocol = EQ)]
pub fn eq(&self, other: &Self) -> VmResult<bool> {
self.eq_with(other, &mut EnvProtocolCaller)
}
pub(crate) fn eq_with(&self, b: &Self, caller: &mut dyn ProtocolCaller) -> VmResult<bool> {
if !vm_try!(Value::eq_with(&self.start, &b.start, caller)) {
return VmResult::Ok(false);
}
Value::eq_with(&self.end, &b.end, caller)
}
/// Test the range for partial ordering.
///
/// # Examples
///
/// ```rune
/// assert!(('a'..'e') < ('b'..'e'));
/// assert!(('c'..'e') > ('b'..'e'));
/// assert!(!((f64::NAN..2.0) > (f64::INFINITY..2.0)));
/// assert!(!((f64::NAN..2.0) < (f64::INFINITY..2.0)));
/// ```
#[rune::function(keep, protocol = PARTIAL_CMP)]
pub fn partial_cmp(&self, other: &Self) -> VmResult<Option<Ordering>> {
self.partial_cmp_with(other, &mut EnvProtocolCaller)
}
pub(crate) fn partial_cmp_with(
&self,
b: &Self,
caller: &mut dyn ProtocolCaller,
) -> VmResult<Option<Ordering>> {
match vm_try!(Value::partial_cmp_with(&self.start, &b.start, caller)) {
Some(Ordering::Equal) => (),
other => return VmResult::Ok(other),
}
Value::partial_cmp_with(&self.end, &b.end, caller)
}
/// Test the range for total ordering.
///
/// # Examples
///
/// ```rune
/// use std::ops::cmp;
/// use std::cmp::Ordering;
///
/// assert_eq!(cmp('a'..'e', 'b'..'e'), Ordering::Less);
/// assert_eq!(cmp('c'..'e', 'b'..'e'), Ordering::Greater);
/// ```
#[rune::function(keep, protocol = CMP)]
pub fn cmp(&self, other: &Self) -> VmResult<Ordering> {
self.cmp_with(other, &mut EnvProtocolCaller)
}
pub(crate) fn cmp_with(&self, b: &Self, caller: &mut dyn ProtocolCaller) -> VmResult<Ordering> {
match vm_try!(Value::cmp_with(&self.start, &b.start, caller)) {
Ordering::Equal => (),
other => return VmResult::Ok(other),
}
Value::cmp_with(&self.end, &b.end, caller)
}
/// Test if the range contains the given value.
///
/// The check is performed using the [`PARTIAL_CMP`] protocol.
///
/// # Examples
///
/// ```rune
/// let range = 0..10;
///
/// assert!(!range.contains(-10));
/// assert!(range.contains(5));
/// assert!(!range.contains(10));
/// assert!(!range.contains(20));
///
/// assert!(range is std::ops::Range);
/// ```
#[rune::function(keep)]
pub(crate) fn contains(&self, value: Value) -> VmResult<bool> {
self.contains_with(value, &mut EnvProtocolCaller)
}
pub(crate) fn contains_with(
&self,
value: Value,
caller: &mut dyn ProtocolCaller,
) -> VmResult<bool> {
match vm_try!(Value::partial_cmp_with(&self.start, &value, caller)) {
Some(Ordering::Less | Ordering::Equal) => {}
_ => return VmResult::Ok(false),
}
VmResult::Ok(matches!(
vm_try!(Value::partial_cmp_with(&self.end, &value, caller)),
Some(Ordering::Greater)
))
}
}
impl fmt::Debug for Range {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{:?}..{:?}", self.start, self.end)
}
}
impl<Idx> ToValue for ops::Range<Idx>
where
Idx: ToValue,
{
fn to_value(self) -> Result<Value, RuntimeError> {
let start = self.start.to_value()?;
let end = self.end.to_value()?;
let range = Range::new(start, end);
Ok(Value::new(range)?)
}
}
impl<Idx> FromValue for ops::Range<Idx>
where
Idx: FromValue,
{
#[inline]
fn from_value(value: Value) -> Result<Self, RuntimeError> {
let range = value.downcast::<Range>()?;
let start = Idx::from_value(range.start)?;
let end = Idx::from_value(range.end)?;
Ok(ops::Range { start, end })
}
}
double_ended_range_iter!(Range, RangeIter<T>, {
#[rune::function(instance, keep, protocol = SIZE_HINT)]
#[inline]
pub(crate) fn size_hint(&self) -> (usize, Option<usize>) {
self.iter.size_hint()
}
#[rune::function(instance, keep, protocol = LEN)]
#[inline]
pub(crate) fn len(&self) -> VmResult<usize>
where
T: Copy + StepsBetween + fmt::Debug,
{
let Some(result) = T::steps_between(self.iter.start, self.iter.end) else {
return VmResult::panic(format!(
"could not calculate length of range {:?}..={:?}",
self.iter.start, self.iter.end
));
};
VmResult::Ok(result)
}
});