Struct Array 

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

A sequence of values.

Implementations

impl Array

pub fn new() -> Self

Create a new, empty array.

pub fn with_capacity(capacity: usize) -> Self

Creates a new vec, with a known capacity.

pub fn is_empty(&self) -> bool

Return true if the length is 0.

pub fn as_slice(&self) -> &[Value]

Extract a slice of the whole array.

pub fn iter(&self) -> Iter<'_, Value>

Iterate over references to the contained values.

pub fn first_mut(&mut self) -> StrResult<&mut Value>

Mutably borrow the first value in the array.

pub fn last_mut(&mut self) -> StrResult<&mut Value>

Mutably borrow the last value in the array.

pub fn at_mut(&mut self, index: i64) -> StrResult<&mut Value>

Mutably borrow the value at the given index.

pub fn repeat(&self, n: usize) -> StrResult<Self>

Repeat this array n times.

impl Array

pub fn construct(value: ToArray) -> Array

Converts a value to an array.

pub fn len(&self) -> usize

The number of values in the array.

pub fn first(&self, default: Option<Value>) -> StrResult<Value>

Returns the first item in the array.

pub fn last(&self, default: Option<Value>) -> StrResult<Value>

Returns the last item in the array.

pub fn at(&self, index: i64, default: Option<Value>) -> StrResult<Value>

Returns the item at the specified index in the array.

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

Adds a value to the end of the array.

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

Removes the last item from the array and returns it.

pub fn insert(&mut self, index: i64, value: Value) -> StrResult<()>

Inserts a value into the array at the specified index, shifting all subsequent elements to the right.

pub fn remove(&mut self, index: i64, default: Option<Value>) -> StrResult<Value>

Removes the value at the specified index from the array and return it.

pub fn slice( &self, start: i64, end: Option<i64>, count: Option<i64>, ) -> StrResult<Array>

Extracts a subslice of the array.

pub fn contains(&self, value: Value) -> bool

Whether the array contains the specified value.

pub fn find( &self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, searcher: Func, ) -> SourceResult<Option<Value>>

Searches for an item for which the given function returns {true} and returns the first match or {none} if there is no match.

pub fn position( &self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, searcher: Func, ) -> SourceResult<Option<i64>>

Searches for an item for which the given function returns {true} and returns the index of the first match or {none} if there is no match.

pub fn range( args: &mut Args, inclusive: bool, step: NonZeroI64, ) -> SourceResult<Array>

Create an array consisting of a sequence of numbers.

pub fn filter( &self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, test: Func, ) -> SourceResult<Array>

Produces a new array with only the items from the original one for which the given function returns {true}.

pub fn map( self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, mapper: Func, ) -> SourceResult<Array>

Produces a new array in which all items from the original one were transformed with the given function.

pub fn enumerate(self, start: i64) -> StrResult<Array>

Returns a new array with the values alongside their indices.

pub fn zip(self, args: &mut Args, exact: bool) -> SourceResult<Array>

Zips the array with other arrays.

pub fn fold( self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, init: Value, folder: Func, ) -> SourceResult<Value>

Folds all items into a single value using an accumulator function.

pub fn sum(self, default: Option<Value>) -> HintedStrResult<Value>

Sums all items (works for all types that can be added).

pub fn product(self, default: Option<Value>) -> HintedStrResult<Value>

Calculates the product of all items (works for all types that can be multiplied).

pub fn any( self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, test: Func, ) -> SourceResult<bool>

Whether the given function returns {true} for any item in the array.

pub fn all( self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, test: Func, ) -> SourceResult<bool>

Whether the given function returns {true} for all items in the array.

pub fn flatten(self) -> Array

Combine all nested arrays into a single flat one.

pub fn rev(self) -> Array

Return a new array with the same items, but in reverse order.

pub fn split(&self, at: Value) -> Array

Split the array at occurrences of the specified value.

pub fn join( self, separator: Option<Value>, last: Option<Value>, default: Option<Value>, ) -> StrResult<Value>

Combine all items in the array into one.

pub fn intersperse(self, separator: Value) -> Array

Returns an array with a copy of the separator value placed between adjacent elements.

pub fn chunks(self, chunk_size: NonZeroUsize, exact: bool) -> Array

Splits an array into non-overlapping chunks, starting at the beginning, ending with a single remainder chunk.

pub fn windows(self, window_size: NonZeroUsize) -> Array

Returns sliding windows of window-size elements over an array.

pub fn sorted( self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, span: Span, key: Option<Func>, by: Option<Func>, ) -> SourceResult<Array>

Return a sorted version of this array, optionally by a given key function.

pub fn dedup( self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, key: Option<Func>, ) -> SourceResult<Array>

Deduplicates all items in the array.

pub fn to_dict(self) -> StrResult<Dict>

Converts an array of pairs into a dictionary.

pub fn reduce( self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, reducer: Func, ) -> SourceResult<Value>

Reduces the elements to a single one, by repeatedly applying a reducing operation.

Trait Implementations

impl Add for Array

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: Array) -> Self::Output

Performs the + operation.

impl AddAssign for Array

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Array

fn clone(&self) -> Array

Returns a duplicate 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() -> Array

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Array

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<Value> for Array

fn extend<T: IntoIterator<Item = Value>>(&mut self, iter: T)

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 From<&[Value]> for Array

fn from(v: &[Value]) -> Self

Converts to this type from the input type.

impl From<EcoVec<Value>> for Array

fn from(v: EcoVec<Value>) -> Self

Converts to this type from the input type.

impl FromIterator<Value> for Array

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

Creates a value from an iterator.

impl FromValue for Array

fn from_value(value: Value) -> HintedStrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for Array

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for Array

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

fn into_value(self) -> Value

Cast this type into a value.

impl NativeScope for Array

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl NativeType for Array

const NAME: &'static str = "array"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl PartialEq for Array

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Reflect for Array

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for Array

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Serialize for Array

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Array