Struct muse_lang::runtime::map::Map

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

A collection of key-value pairs.

Implementations

impl Map

pub const fn new() -> Self

Returns an empty map.

pub fn from_iterator( vm: &mut VmContext<'_, '_>, iter: impl IntoIterator<Item = (Value, Value)>, ) -> Self

Creates a map from an iterator of key-value pairs.

pub fn get( &self, vm: &mut VmContext<'_, '_>, key: &Value, ) -> Result<Option<Value>, Fault>

Returns the value contained for key, or None if this map does not contain key.

Errors

This function does not directly return any errors, but comparing values can result in runtime errors.

pub fn nth( &self, index: &Value, guard: &CollectionGuard<'_>, ) -> Result<Value, Fault>

Returns the value contained at index.

Errors

Returns Fault::OutOfBounds if index is out of bounds of this collection.

pub fn insert( &self, vm: &mut VmContext<'_, '_>, key: Value, value: Value, ) -> Result<Option<Value>, Fault>

Inserts a key-value pair into this map.

If an existing value is stored for key, it will be returned.

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

Returns this map as a vec of fields.

Trait Implementations

impl CustomType for Map

fn muse_type(&self) -> &TypeRef

Returns the Muse type for this Rust type.

impl Debug for Map

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

Formats the value using the given formatter.

impl Default for Map

fn default() -> Self

Returns the “default value” for a type.

impl Trace for Map

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.