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 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
//! Types for working with Ruby ranges.
use std::{
fmt,
ops::{Range as StdRange, RangeFrom, RangeFull, RangeInclusive, RangeTo, RangeToInclusive},
os::raw::{c_int, c_long},
};
use rb_sys::{rb_range_beg_len, rb_range_new};
use crate::{
error::{protect, Error},
into_value::{IntoValue, IntoValueFromNative},
object::Object,
r_struct::RStruct,
try_convert::TryConvert,
value::{
private::{self, ReprValue as _},
ReprValue, Value,
},
Ruby,
};
/// # `Range`
///
/// Functions that can be used to create Ruby `Range`s.
///
/// See also the [`Range`] type.
impl Ruby {
/// Create a new `Range`.
///
/// Returns `Err` if `beg` and `end` are not comparable.
///
/// # Examples
///
/// ```
/// use magnus::{rb_assert, Error, Ruby};
///
/// fn example(ruby: &Ruby) -> Result<(), Error> {
/// let range = ruby.range_new(2, 7, false)?;
/// rb_assert!(ruby, "range == (2..7)", range);
///
/// Ok(())
/// }
/// # Ruby::init(example).unwrap()
/// ```
///
/// ```
/// use magnus::{rb_assert, Error, Ruby};
///
/// fn example(ruby: &Ruby) -> Result<(), Error> {
/// let range = ruby.range_new(2, 7, true)?;
/// rb_assert!(ruby, "range == (2...7)", range);
///
/// Ok(())
/// }
/// # Ruby::init(example).unwrap()
/// ```
pub fn range_new<T, U>(&self, beg: T, end: U, excl: bool) -> Result<Range, Error>
where
T: IntoValue,
U: IntoValue,
{
protect(|| unsafe {
Range(RStruct::from_rb_value_unchecked(rb_range_new(
self.into_value(beg).as_rb_value(),
self.into_value(end).as_rb_value(),
excl as c_int,
)))
})
}
}
/// Wrapper type for a Value known to be an instance of Ruby's Range class.
///
/// See the [`ReprValue`] and [`Object`] traits for additional methods
/// available on this type. See [`Ruby`](Ruby#range) for methods to create a
/// `Range`.
#[derive(Clone, Copy)]
#[repr(transparent)]
pub struct Range(RStruct);
impl Range {
/// Return `Some(Range)` if `val` is an `Range`, `None` otherwise.
///
/// # Examples
///
/// ```
/// use magnus::eval;
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// assert!(magnus::Range::from_value(eval("2..7").unwrap()).is_some());
/// assert!(magnus::Range::from_value(eval("1").unwrap()).is_none());
/// ```
#[inline]
pub fn from_value(val: Value) -> Option<Self> {
RStruct::from_value(val)
.filter(|_| val.is_kind_of(Ruby::get_with(val).class_range()))
.map(Self)
}
/// Create a new `Range`.
///
/// Returns `Err` if `beg` and `end` are not comparable.
///
/// # Panics
///
/// Panics if called from a non-Ruby thread. See [`Ruby::range_new`] for
/// the non-panicking version.
///
/// # Examples
///
/// ```
/// use magnus::rb_assert;
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// let range = magnus::Range::new(2, 7, false).unwrap();
/// rb_assert!("range == (2..7)", range);
/// ```
///
/// ```
/// use magnus::rb_assert;
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// let range = magnus::Range::new(2, 7, true).unwrap();
/// rb_assert!("range == (2...7)", range);
/// ```
#[cfg_attr(
not(feature = "friendly-api"),
deprecated(note = "please use `Ruby::range_new` instead")
)]
#[inline]
pub fn new<T, U>(beg: T, end: U, excl: bool) -> Result<Self, Error>
where
T: IntoValue,
U: IntoValue,
{
get_ruby!().range_new(beg, end, excl)
}
/// Return the value that defines the beginning of the range, converting it
/// to a `T`.
///
/// Errors if the conversion fails.
///
/// # Examples
///
/// ```
/// use magnus::eval;
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// let range: magnus::Range = eval("2..7").unwrap();
/// assert_eq!(range.beg::<i64>().unwrap(), 2);
/// ```
pub fn beg<T>(self) -> Result<T, Error>
where
T: TryConvert,
{
self.0.get(0)
}
/// Return the value that defines the end of the range, converting it
/// to a `T`.
///
/// Errors if the conversion fails.
///
/// # Examples
///
/// ```
/// use magnus::eval;
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// let range: magnus::Range = eval("2..7").unwrap();
/// assert_eq!(range.end::<i64>().unwrap(), 7);
/// ```
pub fn end<T>(self) -> Result<T, Error>
where
T: TryConvert,
{
self.0.get(1)
}
/// Returns `true` if the range excludes its end value, `false` if the end
/// value is included.
///
/// # Examples
///
/// ```
/// use magnus::eval;
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// let range: magnus::Range = eval("2..7").unwrap();
/// assert_eq!(range.excl(), false);
/// ```
pub fn excl(self) -> bool {
self.0.get::<Value>(2).unwrap().to_bool()
}
/// Given a total `length`, returns a beginning index and length of the
/// range within that total length.
///
/// Returns `Err` if `self` is a non-numerical range, or the range is out
/// of range for `length`.
///
/// # Examples
///
/// ```
/// use magnus::eval;
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// let range: magnus::Range = eval("2..").unwrap();
/// assert_eq!(range.beg_len(10).unwrap(), (2, 8));
/// ```
///
/// ```
/// use magnus::eval;
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// # #[cfg(ruby_gte_2_7)]
/// let range: magnus::Range = eval("..7").unwrap();
/// # #[cfg(ruby_gte_2_7)]
/// assert_eq!(range.beg_len(10).unwrap(), (0, 8));
/// ```
///
/// ```
/// use magnus::eval;
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// let range: magnus::Range = eval("-3..-1").unwrap();
/// assert_eq!(range.beg_len(10).unwrap(), (7, 3));
/// ```
pub fn beg_len(self, length: usize) -> Result<(usize, usize), Error> {
let mut begp: c_long = 0;
let mut lenp: c_long = 0;
protect(|| unsafe {
Value::new(rb_range_beg_len(
self.as_rb_value(),
&mut begp as *mut _,
&mut lenp as *mut _,
length as c_long,
1,
))
})?;
Ok((begp as usize, lenp as usize))
}
/// Given a total `length`, converts the Ruby `Range` to a Rust
/// [`std::ops::Range`].
///
/// `length` is required to account for Ruby conventions such as a range
/// from `-2..-1` returning the end of a collection.
///
/// Returns `Err` if `self` is a non-numerical range, or the range is out
/// of range for `length`.
///
/// # Examples
///
/// ```
/// use magnus::eval;
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// // Ruby's .. range is inclusive
/// let range: magnus::Range = eval("2..7").unwrap();
/// // Rust's .. range in exclusive
/// assert_eq!(range.to_range_with_len(10).unwrap(), 2..8);
/// ```
///
/// ```
/// use magnus::eval;
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// let range: magnus::Range = eval("2..").unwrap();
/// assert_eq!(range.to_range_with_len(10).unwrap(), 2..10);
/// ```
///
/// ```
/// use magnus::eval;
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// # #[cfg(ruby_gte_2_7)]
/// let range: magnus::Range = eval("..7").unwrap();
/// # #[cfg(ruby_gte_2_7)]
/// assert_eq!(range.to_range_with_len(10).unwrap(), 0..8);
/// ```
///
/// ```
/// use magnus::eval;
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// let range: magnus::Range = eval("-3..-1").unwrap();
/// assert_eq!(range.to_range_with_len(10).unwrap(), 7..10);
/// ```
pub fn to_range_with_len(self, length: usize) -> Result<StdRange<usize>, Error> {
let (beg, len) = self.beg_len(length)?;
Ok(beg..(beg + len))
}
}
impl fmt::Display for Range {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", unsafe { self.to_s_infallible() })
}
}
impl fmt::Debug for Range {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.inspect())
}
}
impl IntoValue for Range {
#[inline]
fn into_value_with(self, handle: &Ruby) -> Value {
self.0.into_value_with(handle)
}
}
impl<T> IntoValue for StdRange<T>
where
T: IntoValue,
{
#[inline]
fn into_value_with(self, handle: &Ruby) -> Value {
handle
.range_new(self.start, self.end, true)
.unwrap()
.into_value_with(handle)
}
}
unsafe impl<T> IntoValueFromNative for StdRange<T> where T: IntoValueFromNative {}
impl<T> IntoValue for RangeFrom<T>
where
T: IntoValue,
{
#[inline]
fn into_value_with(self, handle: &Ruby) -> Value {
handle
.range_new(self.start, handle.qnil(), false)
.unwrap()
.into_value_with(handle)
}
}
unsafe impl<T> IntoValueFromNative for RangeFrom<T> where T: IntoValueFromNative {}
impl IntoValue for RangeFull {
#[inline]
fn into_value_with(self, handle: &Ruby) -> Value {
handle
.range_new(handle.qnil(), handle.qnil(), false)
.unwrap()
.into_value_with(handle)
}
}
unsafe impl IntoValueFromNative for RangeFull {}
impl<T> IntoValue for RangeInclusive<T>
where
T: IntoValue,
{
#[inline]
fn into_value_with(self, handle: &Ruby) -> Value {
let (start, end) = self.into_inner();
handle
.range_new(start, end, false)
.unwrap()
.into_value_with(handle)
}
}
unsafe impl<T> IntoValueFromNative for RangeInclusive<T> where T: IntoValueFromNative {}
impl<T> IntoValue for RangeTo<T>
where
T: IntoValue,
{
#[inline]
fn into_value_with(self, handle: &Ruby) -> Value {
handle
.range_new(handle.qnil(), self.end, true)
.unwrap()
.into_value_with(handle)
}
}
unsafe impl<T> IntoValueFromNative for RangeTo<T> where T: IntoValueFromNative {}
impl<T> IntoValue for RangeToInclusive<T>
where
T: IntoValue,
{
#[inline]
fn into_value_with(self, handle: &Ruby) -> Value {
handle
.range_new(handle.qnil(), self.end, false)
.unwrap()
.into_value_with(handle)
}
}
unsafe impl<T> IntoValueFromNative for RangeToInclusive<T> where T: IntoValueFromNative {}
impl Object for Range {}
unsafe impl private::ReprValue for Range {}
impl ReprValue for Range {}
impl TryConvert for Range {
fn try_convert(val: Value) -> Result<Self, Error> {
Self::from_value(val).ok_or_else(|| {
Error::new(
Ruby::get_with(val).exception_type_error(),
format!("no implicit conversion of {} into Range", unsafe {
val.classname()
},),
)
})
}
}