Struct rune::runtime::RangeFrom

pub struct RangeFrom {
    pub start: Value,
}

Type for a from range expression start...

Examples

let range = 0..;

assert!(!range.contains(-10));
assert!(range.contains(5));
assert!(range.contains(10));
assert!(range.contains(20));

assert!(range is std::ops::RangeFrom);

Ranges can contain any type:

let range = 'a'..;
assert_eq!(range.start, 'a');
range.start = 'b';
assert_eq!(range.start, 'b');

Certain ranges can be used as iterators:

let range = 'a'..;
assert_eq!(range.iter().take(5).collect::<Vec>(), ['a', 'b', 'c', 'd', 'e']);

Rust examples

use rune::runtime::RangeFrom;

let start = rune::to_value(1)?;
let _ = RangeFrom::new(start);

Fields

start: Value

The start value of the range.

Implementations

impl RangeFrom

pub fn new(start: Value) -> Self

Construct a new range.

pub fn iter(&self) -> VmResult<Iterator>

Iterate over the range.

Panics

This panics if the range is not a well-defined range.

Examples

let range = 'a'..;
assert_eq!(range.iter().take(5).collect::<Vec>(), ['a', 'b', 'c', 'd', 'e']);

Cannot construct an iterator over floats:

let range = 1.0..;
range.iter()

pub fn into_iter(&self) -> VmResult<Iterator>

Build an iterator over the range.

Panics

This panics if the range is not a well-defined range.

Examples

let vec = [];

for value in 'a'.. {
    vec.push(value);

    if value == 'e' {
       break;
    }
}

assert_eq!(vec, ['a', 'b', 'c', 'd', 'e']);

Cannot construct an iterator over floats:

let range = 1.0..;

for value in 1.0 .. {
}

pub fn partial_eq(&self, other: &Self) -> VmResult<bool>

Test the range for partial equality.

Examples

let range = 'a'..;
assert!(range == ('a'..));
assert!(range != ('b'..));

let range = 1.0..;
assert!(range == (1.0..));
assert!(range != (f64::NAN..));
assert!((f64::NAN..) != (f64::NAN..));

pub fn eq(&self, other: &Self) -> VmResult<bool>

Test the range for total equality.

Examples

use std::ops::eq;

let range = 'a'..;
assert!(eq(range, 'a'..));
assert!(!eq(range, 'b'..));

pub fn partial_cmp(&self, other: &Self) -> VmResult<Option<Ordering>>

Test the range for partial ordering.

Examples

assert!(('a'..) < ('b'..));
assert!(('c'..) > ('b'..));
assert!(!((f64::NAN..) > (f64::INFINITY..)));
assert!(!((f64::NAN..) < (f64::INFINITY..)));

pub fn cmp(&self, other: &Self) -> VmResult<Ordering>

Test the range for total ordering.

Examples

use std::ops::cmp;
use std::cmp::Ordering;

assert_eq!(cmp('a'.., 'b'..), Ordering::Less);
assert_eq!(cmp('c'.., 'b'..), Ordering::Greater);

Trait Implementations

impl Clone for RangeFrom

fn clone(&self) -> RangeFrom

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RangeFrom

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

Formats the value using the given formatter.

impl FromValue for RangeFrom

fn from_value(value: Value) -> VmResult<Self>

Try to convert to the given type, from the given value.

impl InstallWith for RangeFrom

fn install_with(module: &mut Module) -> Result<(), ContextError>

Hook to install more things into the module.

impl MaybeTypeOf for RangeFrom

fn maybe_type_of() -> Option<FullTypeOf>

Type information for the given type.

impl Named for RangeFrom

const BASE_NAME: RawStr = _

The generic name of the named thing.

fn full_name() -> Box<str>

The exact type name

impl ToValue for RangeFrom

fn to_value(self) -> VmResult<Value>

Convert into a value.

impl TryFrom<RangeFrom> for Value

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: RangeFrom) -> Result<Self, Error>

Performs the conversion.

impl TypeOf for RangeFrom

fn type_hash() -> Hash

Get full type hash, including type parameters.

fn type_info() -> TypeInfo

Access diagnostical information on the value type.

fn type_of() -> FullTypeOf

Type information for the given type.

fn type_parameters() -> Hash

Hash of type parameters.

impl UnsafeToMut for RangeFrom

type Guard = RawMut

The raw guard returned.

unsafe fn unsafe_to_mut<'a>( value: Value ) -> VmResult<(&'a mut Self, Self::Guard)>

Safety

impl UnsafeToRef for RangeFrom

type Guard = RawRef

The raw guard returned.

unsafe fn unsafe_to_ref<'a>(value: Value) -> VmResult<(&'a Self, Self::Guard)>

Safety