Struct rosy::Range

#[repr(transparent)]
pub struct Range<S = AnyObject, E = S> { /* fields omitted */ }

An instance of Ruby's Range type.

This type supports being instantiated from Range, RangeInclusive, and RangeTo.

a..b and a...b versus a..b and a..=b

In Rust (and many other languages), a..b denotes an inclusive range. However, in Ruby this syntax denotes an exclusive range.

In Rust, a..=b denotes an exclusive range whereas in Ruby, ... denotes an inclusive range.

Examples

An exclusive range can be instantiated quite simply:

use rosy::{Range, Integer, Object};

let range = Range::<Integer>::new(0..10).unwrap();
assert_eq!(range.to_s(), "0...10");

The start and end bounds can be retrieved via into_bounds:

use std::ops::Bound;

let range = Range::<Integer>::new(1..=10).unwrap();

let (start, end) = range.into_bounds();

assert_eq!(start, 1);
assert_eq!(end, Bound::Included(Integer::from(10)));

Methods

impl Range

pub fn from_bounds(
    start: AnyObject,
    end: AnyObject,
    exclusive: bool
) -> Result<Self>

Creates a new instance from the given bounds, returning an exception if one is raised.

If end is nil, an infinite (unbounded) range is produced.

pub unsafe fn from_bounds_unchecked(
    start: AnyObject,
    end: AnyObject,
    exclusive: bool
) -> Self

Creates a new instance from the given bounds, without checking for exceptions.

If end is nil, an infinite (unbounded) range is produced.

Safety

An exception may be raised if start and end cannot be compared.

impl<S: Object, E: Object> Range<S, E>

pub fn new<R, A, B>(range: R) -> Result<Self> where
    R: IntoBounds<A, B>,
    A: Into<S>,
    B: Into<E>, 

Creates a new instance from range, returning an exception if one is raised.

pub unsafe fn new_unchecked<R, A, B>(range: R) -> Self where
    R: IntoBounds<A, B>,
    A: Into<S>,
    B: Into<E>, 

Creates a new instance from range, without checking for exceptions.

Safety

An exception may be raised if S and E cannot be compared.

pub fn into_any_range(self) -> Range

Returns a range over AnyObjects.

pub fn into_bounds(self) -> (S, Bound<E>)

Returns the start (inclusive) and end bounds of self.

Trait Implementations

impl<S: Object, E: Object> Object for Range<S, E>

fn unique_id() -> Option<u128>

Returns a unique identifier for an object type to facilitate casting.

unsafe fn from_raw(raw: usize) -> Self

Creates a new object from raw without checking.

fn cast<A: Object>(obj: A) -> Option<Self>

Attempts to create an instance by casting obj.

unsafe fn cast_unchecked(obj: impl Object) -> Self

Casts obj to Self without checking its type.

fn into_any_object(self) -> AnyObject

Returns self as an AnyObject.

fn as_any_object(&self) -> &AnyObject

Returns a reference to self as an AnyObject.

fn as_any_slice(&self) -> &[AnyObject]

Returns self as a reference to a single-element slice.

fn raw(self) -> usize

Returns the raw object pointer.

unsafe fn as_unchecked<O: Object>(&self) -> &O

Casts self to O without checking whether it is one.

unsafe fn into_unchecked<O: Object>(self) -> O

Converts self to O without checking whether it is one.

fn id(self) -> u64

Returns the object's identifier.

fn ty(self) -> Ty

Returns the virtual type of self.

fn is_ty(self, ty: Ty) -> bool

Returns whether the virtual type of self is ty.

fn class(self) -> Class<Self>

Returns the Class for self.

fn singleton_class(self) -> Class<Self>

Returns the singleton Class of self, creating one if it doesn't exist already.

fn mark(self)

Marks self for Ruby to avoid garbage collecting it.

unsafe fn force_recycle(self)

Forces the garbage collector to free the contents of self.

fn def_singleton_method<N, F>(self, name: N, f: F) -> Result where
    N: Into<SymbolId>,
    F: MethodFn<Self>, 

Defines a method for name on the singleton class of self that calls f when invoked.

unsafe fn def_singleton_method_unchecked<N, F>(self, name: N, f: F) where
    N: Into<SymbolId>,
    F: MethodFn<Self>, 

Defines a method for name on the singleton class of self that calls f when invoked.

unsafe fn call(self, method: impl Into<SymbolId>) -> AnyObject

Calls method on self and returns its output.

unsafe fn call_protected(self, method: impl Into<SymbolId>) -> Result<AnyObject>

Calls method on self and returns its output, or an exception if one is raised.

unsafe fn call_with(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> AnyObject

Calls method on self with args and returns its output.

unsafe fn call_with_protected(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> Result<AnyObject>

Calls method on self with args and returns its output, or an exception if one is raised.

unsafe fn call_public(self, method: impl Into<SymbolId>) -> AnyObject

Calls the public method on self and returns its output.

unsafe fn call_public_protected(
    self,
    method: impl Into<SymbolId>
) -> Result<AnyObject>

Calls the public method on self and returns its output, or an exception if one is raised.

unsafe fn call_public_with(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> AnyObject

Calls the public method on self with args and returns its output.

unsafe fn call_public_with_protected(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> Result<AnyObject>

Calls the public method on self with args and returns its output, or an exception if one is raised.

fn inspect(self) -> String

Returns a printable string representation of self.

fn to_s(self) -> String

Returns the result of calling the to_s method on self.

fn is_frozen(self) -> bool

Returns whether modifications can be made to self.

fn freeze(self)

Freezes self, preventing any further mutations.

fn is_eql<O: Object>(self, other: &O) -> bool

Returns whether self is equal to other in terms of the eql? method.

fn get_attr<N: Into<SymbolId>>(self, name: N) -> AnyObject

Returns the value for the attribute of self associated with name.

unsafe fn eval(self, args: impl EvalArgs) -> AnyObject

Evaluates args in the context of self.

unsafe fn eval_protected(self, args: impl EvalArgs) -> Result<AnyObject>

Evaluates args in the context of self, returning any raised exceptions.

impl<S: Object, E: Object> IntoBounds<S, E> for Range<S, E>

fn into_bounds(self) -> (S, Bound<E>)

Returns the start (inclusive) and end bounds of self.

impl<S: Object, E: Object> PartialEq<AnyObject> for Range<S, E>

fn eq(&self, obj: &AnyObject) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<S, E> Copy for Range<S, E>

impl<S, E> Clone for Range<S, E>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Object, E: Object> AsRef<AnyObject> for Range<S, E>

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl<S: Object, E: Object> From<Range<S, E>> for AnyObject

fn from(object: Range<S, E>) -> AnyObject

Performs the conversion.

impl<S: Object, E: Object> Debug for Range<S, E>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.