Struct Array 

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

Conversion helper for Value::array.

This type wraps Vec<Value> and provides From implementations for common collection types, so that Value::array() can accept them all through a single impl Into<Array> bound.

Supported source types (where T: Into<Value>):

• [T; N] — fixed-size array
• &[T] — slice (requires T: Copy)
• Vec<T> — vector
• Box<[T]> — boxed slice
• () — empty array

Elements are converted to Value via their Into<Value> implementation. This means any type that implements Into<Value> (integers, strings, booleans, floats, nested Values, etc.) can be used as elements.

// From a fixed-size array of integers:
let a = Value::array([1, 2, 3]);

// From a Vec of strings:
let b = Value::array(vec!["x", "y"]);

// From a slice:
let items: &[i32] = &[10, 20];
let c = Value::array(items);

// Empty array via ():
let d = Value::array(());
assert_eq!(d.len(), Some(0));

Implementations

impl Array

pub const fn new() -> Self

Create an empty array.

pub const fn get_ref(&self) -> &Vec<Value>

Borrow the inner Vec.

pub fn get_mut(&mut self) -> &mut Vec<Value>

Mutably borrow the inner Vec.

pub fn into_inner(self) -> Vec<Value>

Unwrap into the inner Vec.

pub fn from_sequence<I>(items: I) -> Self

where I: IntoIterator<Item = Value>,

Build an array from an iterator of values.

This is the write-side counterpart of iterating a CBOR sequence into an array. For the fallible input produced by SequenceDecoder and SequenceReader, use try_from_sequence instead.

let a = Array::from_sequence([Value::from(1), Value::from(2), Value::from(3)]);
assert_eq!(a.get_ref().len(), 3);

pub fn try_from_sequence<I, E>(items: I) -> Result<Self, E>

where I: IntoIterator<Item = Result<Value, E>>,

Build an array from a fallible iterator of values, stopping at the first error.

Accepts any IntoIterator<Item = Result<Value, E>>, which includes both SequenceDecoder (E = Error) and SequenceReader (E = IoError).

// Three concatenated CBOR items: 0x01, 0x02, 0x03.
let a: Array = Array::try_from_sequence(
    DecodeOptions::new().sequence_decoder(&[0x01, 0x02, 0x03]),
).unwrap();
assert_eq!(a.get_ref().len(), 3);

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

fn default() -> Array

Returns the “default value” for a type.

impl<T: Into<Value> + Copy> From<&[T]> for Array

fn from(slice: &[T]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Array> for ValueKey<'a>

fn from(value: &'a Array) -> Self

Converts to this type from the input type.

impl<const N: usize, T: Into<Value>> From<[T; N]> for Array

fn from(array: [T; N]) -> Self

Converts to this type from the input type.

impl From<()> for Array

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<Array> for Value

fn from(value: Array) -> Self

Converts to this type from the input type.

impl<T: Into<Value>> From<Box<[T]>> for Array

fn from(boxed: Box<[T]>) -> Self

Converts to this type from the input type.

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

fn from(vec: Vec<T>) -> 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 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 TryFrom<Value> for Array

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self>

Performs the conversion.

impl Eq for Array

impl StructuralPartialEq for Array