Struct arithmetic_eval::Tuple

pub struct Tuple<T> { /* private fields */ }

Tuple of zero or more values.

A tuple is similar to a Vec with Value elements and can be converted from / to it. It is possible to iterate over elements, index them, etc.

Examples

let mut tuple = Tuple::<u32>::default();
tuple.push(Value::Prim(3));
tuple.push(Value::Prim(5));
assert_eq!(tuple.len(), 2);
assert_eq!(tuple[1], Value::Prim(5));
assert!(tuple.iter().all(|val| !val.is_void()));

// `Tuple` implements `FromIterator` / `Extend`.
let mut other_tuple: Tuple<u32> = (0..=2).map(Value::Prim).collect();
other_tuple.extend(tuple);
assert_eq!(other_tuple.len(), 5);

Implementations

impl<T> Tuple<T>

pub const fn void() -> Self

Creates a new empty tuple (aka a void value).

pub fn len(&self) -> usize

Returns the number of elements in this tuple.

pub fn is_empty(&self) -> bool

Checks if this tuple is empty (has no elements).

pub fn iter(&self) -> impl Iterator<Item = &Value<T>> + '_

Iterates over the elements in this tuple.

pub fn push(&mut self, value: impl Into<Value<T>>)

Pushes a value to the end of this tuple.

Trait Implementations

impl<T: Clone> Clone for Tuple<T>

fn clone(&self) -> Tuple<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Tuple<T>

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

Formats the value using the given formatter.

impl<T> Default for Tuple<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Display> Display for Tuple<T>

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

Formats the value using the given formatter.

impl<T, V> Extend<V> for Tuple<T>

where V: Into<Value<T>>,

fn extend<I: IntoIterator<Item = V>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T> From<Tuple<T>> for Value<T>

fn from(tuple: Tuple<T>) -> Self

Converts to this type from the input type.

impl<T> From<Tuple<T>> for Vec<Value<T>>

fn from(tuple: Tuple<T>) -> Self

Converts to this type from the input type.

impl<T> From<Vec<Value<T>>> for Tuple<T>

fn from(elements: Vec<Value<T>>) -> Self

Converts to this type from the input type.

impl<T, V> FromIterator<V> for Tuple<T>

where V: Into<Value<T>>,

fn from_iter<I: IntoIterator<Item = V>>(iter: I) -> Self

Creates a value from an iterator.

impl<T> Index<usize> for Tuple<T>

type Output = Value<T>

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IntoEvalResult<T> for Tuple<T>

fn into_eval_result(self) -> Result<Value<T>, ErrorOutput>

Performs the conversion.

impl<'r, T> IntoIterator for &'r Tuple<T>

type IntoIter = Iter<'r, Value<T>>

Iterator type should be considered an implementation detail.

type Item = &'r Value<T>

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for Tuple<T>

type IntoIter = IntoIter<Value<T>>

Iterator type should be considered an implementation detail.

type Item = Value<T>

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for Tuple<T>

fn eq(&self, other: &Tuple<T>) -> 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<T> TryFromValue<T> for Tuple<T>

fn try_from_value(value: Value<T>) -> Result<Self, FromValueError>

Attempts to convert value to a type supported by the function.

impl<T> StructuralPartialEq for Tuple<T>