Struct runestick::Vec

#[repr(transparent)]
pub struct Vec { /* fields omitted */ }

Struct representing a dynamic vector.

Examples

let mut vec = runestick::Vec::new();
assert!(vec.is_empty());

vec.push_value(42)?;
vec.push_value(true)?;
assert_eq!(2, vec.len());

assert_eq!(Some(42), vec.get_value(0)?);
assert_eq!(Some(true), vec.get_value(1)?);
assert_eq!(None::<bool>, vec.get_value(2)?);

Implementations

impl Vec

pub const fn new() -> Self

Construct a new empty dynamic vector.

pub fn sort_by<F>(&mut self, compare: F) where
    F: FnMut(&Value, &Value) -> Ordering, 

Sort the vector with the given comparison function.

pub fn with_capacity(cap: usize) -> Self

Construct a new dynamic vector guaranteed to have at least the given capacity.

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

Convert into inner std vector.

pub fn is_empty(&self) -> bool

Returns true if the dynamic vector contains no elements.

pub fn len(&self) -> usize

Returns the number of elements in the dynamic vector, also referred to as its ‘length’.

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

Set by index

pub fn push(&mut self, value: Value)

Appends an element to the back of a dynamic vector.

pub fn push_value<T>(&mut self, value: T) -> Result<(), VmError> where
    T: ToValue, 

Appends an element to the back of a dynamic vector, converting it as necessary through the ToValue trait.

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

Get the value at the given index.

pub fn get_value<T>(&self, index: usize) -> Result<Option<T>, VmError> where
    T: FromValue, 

Get the given value at the given index.

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

Get the mutable value at the given index.

pub fn pop(&mut self) -> Option<Value>

Removes the last element from a dynamic vector and returns it, or None if it is empty.

pub fn remove(&mut self, index: usize)

Removes the element at the specified index from a dynamic vector.

pub fn clear(&mut self)

Clears the vector, removing all values.

Note that this method has no effect on the allocated capacity of the vector.

pub fn insert(&mut self, index: usize, value: Value)

Inserts an element at position index within the vector, shifting all elements after it to the right.

pub fn extend(&mut self, value: Value) -> Result<(), VmError>

Extend this vector with something that implements the into_iter protocol.

pub fn into_iterator(&self) -> Iterator

Convert into a runestick iterator.

Trait Implementations

impl Clone for Vec

fn clone(&self) -> Vec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vec

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

Formats the value using the given formatter.

impl Deref for Vec

type Target = [Value]

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Vec

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<Box<[Value], Global>> for Vec

fn from(inner: Box<[Value]>) -> Self

Performs the conversion.

impl From<Vec<Value, Global>> for Vec

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

Performs the conversion.

impl From<Vec> for Value

fn from(value: Vec) -> Self

Performs the conversion.

impl FromValue for Vec

fn from_value(value: Value) -> Result<Self, VmError>

Try to convert to the given type, from the given value.

impl InstallWith for Vec

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

Hook to install more things into the module.

impl IntoIterator for Vec

type Item = Value

The type of the elements being iterated over.

type IntoIter = IntoIter<Value>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a Vec

type Item = &'a Value

The type of the elements being iterated over.

type IntoIter = Iter<'a, Value>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Vec

type Item = &'a mut Value

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Value>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Named for Vec

const BASE_NAME: RawStr

The generic name of the named thing.

fn full_name() -> String

The exact type name

impl ToValue for Vec

fn to_value(self) -> Result<Value, VmError>

Convert into a value.

impl TypeOf for Vec

fn type_hash() -> Hash

Convert into a type hash.

fn type_info() -> TypeInfo

Access diagnostical information on the value type.

impl<'a> UnsafeFromValue for &'a Vec

type Output = *const Vec

The output type from the unsafe coercion.

type Guard = RawRef

The raw guard returned.

fn from_value(value: Value) -> Result<(Self::Output, Self::Guard), VmError>

Convert the given reference using unsafe assumptions to a value.

unsafe fn unsafe_coerce(output: Self::Output) -> Self

Coerce the output of an unsafe from value into the final output type.

impl<'a> UnsafeFromValue for &'a mut Vec

type Output = *mut Vec

The output type from the unsafe coercion.

type Guard = RawMut

The raw guard returned.

fn from_value(value: Value) -> Result<(Self::Output, Self::Guard), VmError>

Convert the given reference using unsafe assumptions to a value.

unsafe fn unsafe_coerce(output: Self::Output) -> Self

Coerce the output of an unsafe from value into the final output type.