Struct purp_value::types::array::Array

pub struct Array {
    pub values: Vec<Value>,
}

Represents an array of Values.

Fields

values: Vec<Value>

Implementations

impl Array

pub fn new() -> Self

Creates a new empty Array.

Examples

use my_crate::Array;

let empty_array = Array::new();
assert_eq!(empty_array.len(), 0);

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

Appends a value to the end of the array.

Examples

use my_crate::{Array, Value};

let mut array = Array::new();
array.push(Value::from(42));
array.push(Value::from("hello"));

assert_eq!(array.len(), 2);
assert_eq!(array.get(0), Some(&Value::from(42)));
assert_eq!(array.get(1), Some(&Value::from("hello")));

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

Removes the last element from the array and returns it, or None if the array is empty.

Examples

use my_crate::{Array, Value};

let mut array = Array::new();
array.push(Value::from(42));

let popped_value = array.pop();
assert_eq!(popped_value, Some(Value::from(42)));

let empty_array = Array::new();
let empty_popped_value = empty_array.pop();
assert_eq!(empty_popped_value, None);

pub fn len(&self) -> usize

Returns the number of elements in the array.

Examples

use my_crate::{Array, Value};

let mut array = Array::new();
assert_eq!(array.len(), 0);

array.push(Value::from(42));
assert_eq!(array.len(), 1);

pub fn is_empty(&self) -> bool

Returns true if the array contains no elements.

Examples

use my_crate::{Array, Value};

let empty_array = Array::new();
assert!(empty_array.is_empty());

let mut array = Array::new();
array.push(Value::from(42));
assert!(!array.is_empty());

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

Returns a reference to the value at the specified index, or None if the index is out of bounds.

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

Returns a mutable reference to the value at the specified index, or None if the index is out of bounds.

Trait Implementations

impl Clone for Array

fn clone(&self) -> Array

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Array

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

Formats the value using the given formatter.

impl Default for Array

fn default() -> Self

Returns the “default value” for a type.

impl Display for Array

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

Formats the value using the given formatter.

impl<K: AsRef<str>, V: Into<Value>> From<BTreeMap<K, V, Global>> for Array

fn from(map: BTreeMap<K, V>) -> Self

Converts to this type from the input type.

impl<K: AsRef<str>, V: Into<Value>> From<HashMap<K, V, RandomState>> for Array

fn from(map: HashMap<K, V>) -> Self

Converts to this type from the input type.

impl From<Value> for Array

fn from(value: Value) -> Self

Converts to this type from the input type.

impl<T: Into<Value>> From<Vec<T, Global>> for Array

fn from(values: Vec<T>) -> Self

Converts to this type from the input type.

impl<'a> IntoIterator for &'a Array

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 Array

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 IntoIterator for Array

type Item = Value

The type of the elements being iterated over.

type IntoIter = IntoIter<<Array as IntoIterator>::Item, Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Array> for Array

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypeToValue for Array

fn to_value(&self) -> Value

Converts the data type to a Value enum.

impl StructuralPartialEq for Array