Struct rant::RantOrderedCollection

pub struct RantOrderedCollection(_);

Filter type that represents any indexable (ordered) Rant collection type.

Use on native functions to accept any ordered collection type. Derefs to RantValue.

Methods from Deref<Target = RantValue>

pub const NAN: Self = Self::Float(f64::NAN)

pub const INFINITY: Self = Self::Float(f64::INFINITY)

pub const NEG_INFINITY: Self = Self::Float(f64::NEG_INFINITY)

pub const MIN_FLOAT: Self = Self::Float(f64::MIN)

pub const MAX_FLOAT: Self = Self::Float(f64::MAX)

pub const EPSILON: Self = Self::Float(f64::EPSILON)

pub const MIN_INT: Self = Self::Int(i64::MIN)

pub const MAX_INT: Self = Self::Int(i64::MAX)

pub fn is_nothing(&self) -> bool

Returns true if the value is of type nothing.

pub fn is_nan(&self) -> bool

Returns true if the value is NaN (Not a Number).

pub fn is_callable(&self) -> bool

Returns true if the value is callable (e.g. a function).

pub fn to_bool(&self) -> bool

Interprets this value as a boolean value according to Rant’s truthiness rules.

Types are converted as follows:

1. bool returns itself.
2. int returns true for any non-zero value; otherwise, false.
3. float returns true for any normal value; otherwise, false.
4. empty returns false.
5. Collections that can be zero-length (string, list, map, range) return true if their length is nonzero; otherwise, false.
6. All other types return true.

pub fn len(&self) -> usize

Gets the length of the value.

pub fn is_empty(&self) -> bool

Returns true if the length of the value is 0.

pub fn reversed(&self) -> Self

pub fn shallow_copy(&self) -> Self

Returns a shallow copy of the value.

pub fn get_type(&self) -> RantValueType

Gets the Rant type associated with the value.

pub fn type_name(&self) -> &'static str

Gets the type name of the value.

pub fn slice_get(&self, slice: &Slice) -> ValueSliceResult

pub fn is_indexable(&self) -> bool

Indicates whether the value can be indexed into.

pub fn index_get(&self, index: i64) -> ValueIndexResult

Attempts to get a value by index.

pub fn key_get(&self, key: &str) -> ValueKeyResult

Attempts to get a value by key.

Trait Implementations

impl Clone for RantOrderedCollection

fn clone(&self) -> RantOrderedCollection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RantOrderedCollection

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

Formats the value using the given formatter.

impl Deref for RantOrderedCollection

type Target = RantValue

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl PartialEq<RantOrderedCollection> for RantOrderedCollection

fn eq(&self, other: &RantOrderedCollection) -> bool

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

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

This method tests for !=.

impl PartialOrd<RantOrderedCollection> for RantOrderedCollection

fn partial_cmp(&self, other: &RantOrderedCollection) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFromRant for RantOrderedCollection

fn try_from_rant(val: RantValue) -> Result<Self, ValueError>

Convert from a RantValue.

fn is_optional_param_type() -> bool

Returns true if the type can be used to represent an optional Rant parameter in native functions; otherwise, false.

impl StructuralPartialEq for RantOrderedCollection