Struct magnus::Range

pub struct Range(/* private fields */);

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 for methods to create a Range.

Implementations

impl Range

pub fn from_value(val: Value) -> Option<Self>

Return Some(Range) if val is an Range, None otherwise.

Examples

use magnus::eval;

assert!(magnus::Range::from_value(eval("2..7").unwrap()).is_some());
assert!(magnus::Range::from_value(eval("1").unwrap()).is_none());

pub fn new<T, U>(beg: T, end: U, excl: bool) -> Result<Self, Error>

where T: IntoValue, U: IntoValue,

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 range = magnus::Range::new(2, 7, false).unwrap();
rb_assert!("range == (2..7)", range);

use magnus::rb_assert;

let range = magnus::Range::new(2, 7, true).unwrap();
rb_assert!("range == (2...7)", range);

pub fn beg<T>(self) -> Result<T, Error>

where T: TryConvert,

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 range: magnus::Range = eval("2..7").unwrap();
assert_eq!(range.beg::<i64>().unwrap(), 2);

pub fn end<T>(self) -> Result<T, Error>

where T: TryConvert,

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 range: magnus::Range = eval("2..7").unwrap();
assert_eq!(range.end::<i64>().unwrap(), 7);

pub fn excl(self) -> bool

Returns true if the range excludes its end value, false if the end value is included.

Examples

use magnus::eval;

let range: magnus::Range = eval("2..7").unwrap();
assert_eq!(range.excl(), false);

pub fn beg_len(self, length: usize) -> Result<(usize, usize), Error>

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 range: magnus::Range = eval("2..").unwrap();
assert_eq!(range.beg_len(10).unwrap(), (2, 8));

use magnus::eval;

let range: magnus::Range = eval("..7").unwrap();
assert_eq!(range.beg_len(10).unwrap(), (0, 8));

use magnus::eval;

let range: magnus::Range = eval("-3..-1").unwrap();
assert_eq!(range.beg_len(10).unwrap(), (7, 3));

pub fn to_range_with_len(self, length: usize) -> Result<StdRange<usize>, Error>

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;

// 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 range: magnus::Range = eval("2..").unwrap();
assert_eq!(range.to_range_with_len(10).unwrap(), 2..10);

use magnus::eval;

let range: magnus::Range = eval("..7").unwrap();
assert_eq!(range.to_range_with_len(10).unwrap(), 0..8);

use magnus::eval;

let range: magnus::Range = eval("-3..-1").unwrap();
assert_eq!(range.to_range_with_len(10).unwrap(), 7..10);

Trait Implementations

impl Clone for Range

fn clone(&self) -> Range

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Range

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

Formats the value using the given formatter.

impl Display for Range

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

Formats the value using the given formatter.

impl IntoValue for Range

fn into_value_with(self, handle: &Ruby) -> Value

Convert self into Value.

fn into_value(self) -> Value

Convert self into Value.

unsafe fn into_value_unchecked(self) -> Value

Convert self into Value.

impl Object for Range

fn define_singleton_method<M>(self, name: &str, func: M) -> Result<(), Error>

where M: Method,

Define a singleton method in self’s scope.

fn ivar_get<T, U>(self, name: T) -> Result<U, Error>

where T: IntoId, U: TryConvert,

Get the value for the instance variable name within self’s scope.

fn ivar_set<T, U>(self, name: T, value: U) -> Result<(), Error>

where T: IntoId, U: IntoValue,

Set the value for the instance variable name within self’s scope.

fn singleton_class(self) -> Result<RClass, Error>

Finds or creates the singleton class of self.

fn extend_object(self, module: RModule) -> Result<(), Error>

Extend self with module.

impl ReprValue for Range

fn as_value(self) -> Value

Return self as a Value.

fn is_nil(self) -> bool

Returns whether self is Ruby’s nil value.

fn equal<T>(self, other: T) -> Result<bool, Error>

where T: ReprValue,

Checks for equality, delegating to the Ruby method #==.

fn eql<T>(self, other: T) -> Result<bool, Error>

where T: ReprValue,

Checks for equality, delegating to the Ruby method #eql?.

fn hash(self) -> Result<Integer, Error>

Returns an integer non-uniquely identifying self.

fn class(self) -> RClass

Returns the class that self is an instance of.

fn is_frozen(self) -> bool

Returns whether self is ‘frozen’.

fn check_frozen(self) -> Result<(), Error>

Returns an error if self is ‘frozen’.

fn freeze(self)

Mark self as frozen.

fn to_bool(self) -> bool

Convert self to a bool, following Ruby’s rules of false and nil as boolean false and everything else boolean true.

fn funcall<M, A, T>(self, method: M, args: A) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the method named method on self with args.

fn funcall_public<M, A, T>(self, method: M, args: A) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the public method named method on self with args.

fn check_funcall<M, A, T>(self, method: M, args: A) -> Option<Result<T, Error>>

where M: IntoId, A: ArgList, T: TryConvert,

If self responds to the method named method, call it with args.

fn funcall_with_block<M, A, T>( self, method: M, args: A, block: Proc ) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the method named method on self with args and block.

fn block_call<M, A, R, T>( self, method: M, args: A, block: fn(_: &[Value], _: Option<Proc>) -> R ) -> Result<T, Error>

where M: IntoId, A: ArgList, R: BlockReturn, T: TryConvert,

Call the method named method on self with args and block.

fn respond_to<M>(self, method: M, include_private: bool) -> Result<bool, Error>

where M: IntoId,

Check if self responds to the given Ruby method.

fn to_r_string(self) -> Result<RString, Error>

Convert self to a Ruby String.

unsafe fn to_s(&self) -> Result<Cow<'_, str>, Error>

Convert self to a Rust string.

fn inspect(self) -> String

Convert self to its Ruby debug representation.

unsafe fn classname(&self) -> Cow<'_, str>

Return the name of self’s class.

fn is_kind_of<T>(self, class: T) -> bool

where T: ReprValue + Module,

Returns whether or not self is an instance of class.

fn enumeratorize<M, A>(self, method: M, args: A) -> Enumerator

where M: IntoSymbol, A: ArgList,

Generate an Enumerator from method on self, passing args to method.

impl TryConvert for Range

fn try_convert(val: Value) -> Result<Self, Error>

Convert val into Self.

impl Copy for Range