Struct budvm::List

pub struct List(_);

A List type for Bud, which wraps a VecDeque<Value>.

This type uses a Mutex for interior mutability, allowing lists to be cheaply moved around by reference. Each interaction with this type locks the Mutex.

VecDeque was chosen to allow users ultimate flexibility in pushing/popping without worry about performance concerns.

Implementations

impl List

pub fn into_inner(self) -> VecDeque<Value>

Extracts the contained collection type.

pub fn push_front(&self, value: Value)

Pushes value to the front of the list.

pub fn push_back(&self, value: Value)

Pushes value to the back of the list.

pub fn pop_front(&self) -> Option<Value>

Removes the first value in the list.

pub fn pop_back(&self) -> Option<Value>

Removes the last value in the list.

pub fn len(&self) -> usize

Returns the number of values contained in the list.

pub fn is_empty(&self) -> bool

Returns true if this list contains no values.

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

Returns the value contained at index, or None if index is outside of the bounds of this list.

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

Removes the value contained at index, or None if index is outside of the bounds of this list.

Trait Implementations

impl Clone for List

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for List

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

Formats the value using the given formatter.

impl DynamicValue for List

fn is_truthy(&self) -> bool

Returns true if the value contained is truthy. See Value::is_truthy() for examples of what this means for primitive types.

fn kind(&self) -> Symbol

Returns a unique string identifying this type. This returned string will be wrapped in ValueKind::Dynamic when Value::kind() is invoked on a dynamic value.

fn partial_eq(&self, other: &Value) -> Option<bool>

Returns true if self and other are considered equal. Returns false if self and other are able to be compared but are not equal. Returns None if the values are unable to be compared.

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

Returns the relative ordering of self and other, if a comparison is able to be made. If the types cannot be compared, this function should return None.

fn call( &self, name: &Symbol, args: &mut PoppedValues<'_> ) -> Result<Value, FaultKind>

Calls a function by name with args.

fn to_source(&self) -> Option<String>

Returns this value as represented in source, if possible.

fn hash<H>(&self, state: &mut H) -> boolwhere H: Hasher,

Hashes the contents of this value. Returns true if this operation is supported.

fn as_i64(&self) -> Option<i64>

Returns this value as an i64, if possible.

fn convert(&self, kind: &Symbol) -> Option<Value>

Converts this value to the given kind, if possible.

fn checked_add( &self, other: &Value, is_reverse: bool ) -> Result<Option<Value>, FaultKind>

Attempts to compute the result adding self and other.

fn checked_sub( &self, other: &Value, is_reverse: bool ) -> Result<Option<Value>, FaultKind>

Attempts to compute the result subtracting self and other.

fn checked_mul( &self, other: &Value, is_reverse: bool ) -> Result<Option<Value>, FaultKind>

Attempts to compute the result multiplying self and other.

fn checked_div( &self, other: &Value, is_reverse: bool ) -> Result<Option<Value>, FaultKind>

Attempts to compute the result dividing self and other.

impl FromIterator<Value> for List

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

Creates a value from an iterator.