Struct Array

pub struct Array {
    pub value_type: VariantScalarTypeId,
    pub values: Vec<Variant>,
    pub dimensions: Option<Vec<u32>>,
}

An array is a vector of values with an optional number of dimensions. It is expected that the multi-dimensional array is valid, or it might not be encoded or decoded properly. The dimensions should match the number of values, or the array is invalid.

Fields

value_type: VariantScalarTypeId

Type of elements in the array

values: Vec<Variant>

Values are stored sequentially

dimensions: Option<Vec<u32>>

Multi dimension array which can contain any scalar type, all the same type. Nested arrays are rejected. Higher rank dimensions are serialized first. For example an array with dimensions [2,2,2] is written in this order - [0,0,0], [0,0,1], [0,1,0], [0,1,1], [1,0,0], [1,0,1], [1,1,0], [1,1,1].

Implementations

impl Array

pub fn new<V>( value_type: VariantScalarTypeId, values: V, ) -> Result<Array, ArrayError>

where V: Into<Vec<Variant>>,

Constructs a single dimension array from the supplied values

pub fn new_multi<V, D>( value_type: VariantScalarTypeId, values: V, dimensions: D, ) -> Result<Array, ArrayError>

where V: Into<Vec<Variant>>, D: Into<Vec<u32>>,

Constructs a multi-dimensional array from the supplied values. The values are still provided and held as a single dimension array but a separate dimensions parameter indicates how the values are accessed.

pub fn is_valid(&self) -> bool

Whether this is a valid array.

pub fn encoding_mask(&self) -> u8

Encoding mask.

Trait Implementations

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

fn into_variant(self) -> Variant

Convert self into a variant.

impl IntoVariant for Box<Array>

fn into_variant(self) -> Variant

Convert self into a variant.

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