Struct RangeInclusive

pub struct RangeInclusive {
    pub start: Value,
    pub end: Value,
}

Type for an inclusive range expression start..=end.

Examples

let range = 0..=10;

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

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

Ranges can contain any type:

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

Certain ranges can be used as iterators:

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

Rust Examples

use rune::runtime::RangeInclusive;

let start = rune::to_value(1)?;
let end = rune::to_value(10)?;
let _ = RangeInclusive::new(start, end);

Fields

start: Value

The start value of the range.

end: Value

The end value of the range.

Implementations

impl RangeInclusive

pub fn new(start: Value, end: Value) -> Self

Construct a new range.

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

Iterate over the range.

Panics

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

Examples

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

Cannot construct an iterator over floats:

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

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

Iterate over the range.

Panics

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

Examples

let vec = [];

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

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

Cannot construct an iterator over floats:

for value in 1.0..=2.0 {
}

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

Test the range for partial equality.

Examples

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

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

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

Test the range for total equality.

Examples

use std::ops::eq;

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

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

Test the range for partial ordering.

Examples

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

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'..='e', 'b'..='e'), Ordering::Less);
assert_eq!(cmp('c'..='e', 'b'..='e'), Ordering::Greater);

Trait Implementations

impl Any for RangeInclusive

const ANY_TYPE_INFO: AnyTypeInfo = _

The compile-time type information know for the type.

impl Clone for RangeInclusive

fn clone(&self) -> RangeInclusive

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RangeInclusive

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

Formats the value using the given formatter.

impl InstallWith for RangeInclusive

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

Hook to install more things into the module.

impl MaybeTypeOf for RangeInclusive

fn maybe_type_of() -> Result<DocType>

Type information for the given type.

impl Named for RangeInclusive

const ITEM: &'static Item = _

The name item.

fn full_name(f: &mut Formatter<'_>) -> Result

The exact type name

fn display() -> impl Display

Return a display wrapper for the named type.

impl TryClone for RangeInclusive

fn try_clone(&self) -> Result<Self>

Try to clone the current value, raising an allocation error if it’s unsuccessful.

fn try_clone_from(&mut self, source: &Self) -> Result<(), Error>

Performs copy-assignment from source.

impl TypeHash for RangeInclusive

const HASH: Hash = _

The complete type hash of the type including type parameters which uniquely identifiers a given type.

impl TypeOf for RangeInclusive

const PARAMETERS: Hash = _

Type parameters for the type.

const STATIC_TYPE_INFO: AnyTypeInfo = <Self as crate::Any>::ANY_TYPE_INFO

Access diagnostical type information for the current type.

fn type_info() -> TypeInfo

Get type info associated with the current type.

impl UnsafeToMut for RangeInclusive

type Guard = RawValueGuard

The raw guard returned.

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

Safety

impl UnsafeToRef for RangeInclusive

type Guard = RawValueGuard

The raw guard returned.

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

Safety

impl UnsafeToValue for &RangeInclusive

type Guard = ValueRefGuard

The type used to guard the unsafe value conversion.

unsafe fn unsafe_to_value(self) -> Result<(Value, Self::Guard), RuntimeError>

Convert into a value.

impl UnsafeToValue for &mut RangeInclusive

type Guard = ValueMutGuard

The type used to guard the unsafe value conversion.

unsafe fn unsafe_to_value(self) -> Result<(Value, Self::Guard), RuntimeError>

Convert into a value.