Struct polyvalue::types::Array

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

Subtype of Value that represents an array

Implementations

impl Array

pub const MAX_CONVERTIBLE_RANGE: usize = 65_536usize

Largest range that can be converted to an array

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

Pop a value from the array

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

Push a value onto the array

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

Insert a value into the array

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

Remove a value from the array

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

Get a value from the array, if it exists

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

Get a mutable value from the array, if it exists

pub fn len(&self) -> usize

Get the length of the array

pub fn is_empty(&self) -> bool

Determine if the array contains any values

pub fn prealloc_range_conversion(length: usize) -> Result<Self, Error>

Preallocate space for a large array conversion

Trait Implementations

impl Add for Array

type Output = Result<Array, Error>

The resulting type after applying the + operator.

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

Performs the + operation.

impl ArithmeticOperationExt for Array

fn arithmetic_op( self, right: Self, operation: ArithmeticOperation ) -> Result<Self, Error>

Perform an arithmetic operation on two values If the operation is not supported on the given type, an Error::UnsupportedOperation will be returned

fn arithmetic_neg(self) -> Result<Self, Error>

where Self: Sized,

Perform an arithmetic negation on a value This is equivalent to arithmetic_op with ArithmeticOperation::Negate but is provided for convenience

impl BooleanOperationExt for Array

fn boolean_op( self, right: Self, operation: BooleanOperation ) -> Result<Value, Error>

Perform a boolean operation on two values If the operation is not supported on the given type, an Error::UnsupportedOperation will be returned

fn boolean_not(self) -> Result<Value, Error>

where Self: Sized,

Perform a boolean not on a value This is equivalent to boolean_op with BooleanOperation::Not but is provided for convenience

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() -> Array

Returns the “default value” for a type.

impl DerefMut for Array

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

Mutably dereferences the value.

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

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

Formats the value using the given formatter.

impl From<Array> for Value

fn from(v: Array) -> Self

Converts to this type from the input type.

impl<V> From<Vec<V>> for Array

where Value: From<V>,

fn from(v: Vec<V>) -> Self

Converts to this type from the input type.

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

fn get_index_mut(&mut self, index: &Value) -> Result<&mut Value, Error>

Get a value from an index Returns a mutable reference to the value, or an Error::Index if the index is not found

fn get_indices_mut(&mut self, index: &Value) -> Result<Vec<&mut Value>, Error>

Get values from one or more indices, mutably Returns a vector of references to the values, or an Error::Index if any of the indices are not found

fn set_index(&mut self, index: &Value, value: Value) -> Result<(), Error>

Set a value at an index Returns an Error::Index if the index is not found

fn insert_at(&mut self, index: &Value, value: Value) -> Result<(), Error>

Insert a value at an index Returns an Error::Index if the index is out of bounds

fn delete_index(&mut self, index: &Value) -> Result<Value, Error>

Delete a value at an index Returns an Error::Index if the index is not found

impl IndexingOperationExt for Array

fn get_index(&self, index: &Value) -> Result<Value, Error>

Get a value from an index Returns a value, or an Error::Index if the index is not found

fn get_indices(&self, index: &Value) -> Result<Value, Error>

Get values from one or more indices Returns a vector of values, or an Error::Index if any of the indices are not found

impl Into<Vec<Value>> for Array

fn into(self) -> ArrayInner

Converts this type into the (usually inferred) input type.

impl MatchingOperationExt for Array

fn matching_op( container: &Self, pattern: &Value, operation: MatchingOperation ) -> Result<Value, Error>

where Self: Sized,

Perform a matching operation on two values If the operation is not supported on the given type, an Error::UnsupportedOperation will be returned

impl Neg for Array

type Output = Result<Array, Error>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Array

fn cmp(&self, other: &Array) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq 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 PartialOrd for Array

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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

type Output = Result<Array, Error>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl TryFrom<Array> for Bool

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for Currency

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for Fixed

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for Float

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for I16

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for I32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for I64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for I8

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for Object

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for Range

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for Str

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for U16

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for U32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for U64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for U8

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Bool> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Bool) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Currency> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Currency) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Fixed> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Fixed) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Float> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Float) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<I16> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: I16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<I32> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: I32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<I64> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: I64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<I8> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: I8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Object> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Object) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Range> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Range) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Str> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<U16> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: U16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<U32> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: U32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<U64> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: U64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<U8> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: U8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl ValueTrait for Array

type Inner = Vec<Value>

The inner type of the value

fn new(inner: ArrayInner) -> Self

Creates a new value from the given inner value

fn inner(&self) -> &ArrayInner

Returns a reference to the inner value

fn inner_mut(&mut self) -> &mut ArrayInner

Returns a mutable reference to the inner value

fn into_inner(self) -> ArrayInner

Consumes the value and returns the inner value

impl Deref for Array

type Target = <Array as ValueTrait>::Inner

The resulting type after dereferencing.

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

Dereferences the value.

impl Eq for Array

impl StructuralPartialEq for Array