Struct muse_lang::runtime::list::List

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

A list of Values.

Implementations

impl List

pub const fn new() -> Self

Returns an empty list.

pub fn get_by_value(&self, index: &Value) -> Result<Value, Fault>

Returns the value at index.

Errors

Returns Fault::OutOfBounds if index cannot be converted to a usize or is out of bounds of this list.

pub fn get(&self, index: usize) -> Option<Value>

pub fn insert(&self, index: &Value, value: Value) -> Result<(), Fault>

Inserts value at index.

Errors

Returns Fault::OutOfBounds if index cannot be converted to a usize or is greater than the length of this list.

pub fn push(&self, value: Value) -> Result<(), Fault>

Pushes value to the end of the list.

pub fn set(&self, index: &Value, value: Value) -> Result<Value, Fault>

Replaces the value at index with value. Returns the previous value.

Errors

Returns Fault::OutOfBounds if index cannot be converted to a usize or is out of bounds of this list.

pub fn to_vec(&self) -> Vec<Value>

Converts this list into a Vec.

Trait Implementations

impl CustomType for List

fn muse_type(&self) -> &TypeRef

Returns the Muse type for this Rust type.

impl Debug for List

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

Formats the value using the given formatter.

impl Default for List

fn default() -> Self

Returns the “default value” for a type.

impl From<Vec<Value>> for List

fn from(value: Vec<Value>) -> Self

Converts to this type from the input type.

impl FromIterator<Value> for List

fn from_iter<T: IntoIterator<Item = Value>>(iter: T) -> Self

Creates a value from an iterator.

impl Trace for List

const MAY_CONTAIN_REFERENCES: bool = true

If true, this type may contain references and should have its trace() function invoked during the collector’s “mark” phase.

fn trace(&self, tracer: &mut Tracer<'_>)

Traces all refrences that this value references.