rune/runtime/range_to_inclusive.rs
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
use core::cmp::Ordering;
use core::fmt;
use core::ops;
use crate as rune;
use crate::alloc::clone::TryClone;
use crate::runtime::{
EnvProtocolCaller, FromValue, ProtocolCaller, RuntimeError, ToValue, Value, VmResult,
};
use crate::Any;
/// Type for an inclusive range expression `..=end`.
///
/// # Examples
///
/// ```rune
/// let range = ..=10;
/// assert!(range.contains(-10));
/// assert!(range.contains(5));
/// assert!(range.contains(10));
/// assert!(!range.contains(20));
///
/// assert!(range is std::ops::RangeToInclusive);
/// ```
///
/// Ranges can contain any type:
///
/// ```rune
/// let range = ..='f';
/// assert_eq!(range.end, 'f');
/// range.end = 'g';
/// assert_eq!(range.end, 'g');
/// ```
///
/// # Examples
///
/// ```rust
/// use rune::runtime::RangeToInclusive;
///
/// let end = rune::to_value(10)?;
/// let _ = RangeToInclusive::new(end);
/// # Ok::<_, rune::support::Error>(())
/// ```
#[derive(Any, Clone, TryClone)]
#[rune(constructor, item = ::std::ops)]
pub struct RangeToInclusive {
/// The end value of the range.
#[rune(get, set)]
pub end: Value,
}
impl RangeToInclusive {
/// Construct a new range.
pub fn new(end: Value) -> Self {
Self { end }
}
/// Test the range for partial equality.
///
/// # Examples
///
/// ```rune
/// let range = ..='e';
/// assert!(range == (..='e'));
/// assert!(range != (..='f'));
///
/// let range = ..=2.0;
/// assert!(range == (..=2.0));
/// assert!(range != (..=f64::NAN));
/// assert!((..=f64::NAN) != (..=f64::NAN));
/// ```
#[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> {
Value::partial_eq_with(&self.end, &b.end, caller)
}
/// Test the range for total equality.
///
/// # Examples
///
/// ```rune
/// use std::ops::eq;
///
/// let range = ..='e';
/// assert!(eq(range, ..='e'));
/// assert!(!eq(range, ..='f'));
/// ```
#[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> {
Value::eq_with(&self.end, &b.end, caller)
}
/// Test the range for partial ordering.
///
/// # Examples
///
/// ```rune
/// assert!((..='a') < (..='b'));
/// assert!((..='d') > (..='b'));
/// assert!(!((..=f64::NAN) > (..=f64::INFINITY)));
/// assert!(!((..=f64::NAN) < (..=f64::INFINITY)));
/// ```
#[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>> {
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', ..='b'), Ordering::Less);
/// assert_eq!(cmp(..='c', ..='b'), 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> {
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 = ..=10;
///
/// assert!(range.contains(-10));
/// assert!(range.contains(5));
/// assert!(range.contains(10));
/// assert!(!range.contains(20));
///
/// assert!(range is std::ops::RangeToInclusive);
/// ```
#[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> {
VmResult::Ok(matches!(
vm_try!(Value::partial_cmp_with(&self.end, &value, caller)),
Some(Ordering::Greater | Ordering::Equal)
))
}
}
impl fmt::Debug for RangeToInclusive {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "..={:?}", self.end)
}
}
impl<Idx> ToValue for ops::RangeToInclusive<Idx>
where
Idx: ToValue,
{
fn to_value(self) -> Result<Value, RuntimeError> {
let end = self.end.to_value()?;
Ok(Value::new(RangeToInclusive::new(end))?)
}
}
impl<Idx> FromValue for ops::RangeToInclusive<Idx>
where
Idx: FromValue,
{
#[inline]
fn from_value(value: Value) -> Result<Self, RuntimeError> {
let range = value.downcast::<RangeToInclusive>()?;
let end = Idx::from_value(range.end)?;
Ok(ops::RangeToInclusive { end })
}
}