Struct zvariant::Array

pub struct Array(_);

An unordered collection of items of the same type.

API is provided to transform this into, and from a Vec.

Methods

impl Array

pub fn new() -> Self

Creates a new empty Array.

pub fn new_from_vec(vec: Vec<Variant>) -> Result<Self, VariantError>

Creates an Array from given variants.

All variants must all contain the same type.

Example:

use zvariant::{Array, Encode, Variant};

let variants = vec![42u8.to_variant(), 45u8.to_variant()];
let array = Array::new_from_vec(variants).unwrap();

let variants = vec![42u8.to_variant(), 45u32.to_variant()];
assert!(Array::new_from_vec(variants).is_err());

pub fn new_from_vec_unchecked(vec: Vec<Variant>) -> Self

Creates an Array from given variants.

Same as new_from_vec but the caller guarantees all variants in the vec are of the same type.

pub fn add_element<T: Encode>(&mut self, element: T) -> Result<(), VariantError>

Adds the given element to self.

Example:

use zvariant::{Array, Decode, Variant};

let mut array = Array::new();
array.add_element(42u8).unwrap();
assert!(array.add_element("hi").is_err());
array.add_element(45u8).unwrap();
assert!(array.add_element(42u32).is_err());

pub fn get_element<T: Decode>(&self, index: usize) -> Result<&T, VariantError>

Get the element at the given index.

Example:

use zvariant::{Array, Decode, Variant};

let array = Array::from(vec![42u8, 43, 44]);
assert!(*array.get_element::<u8>(0).unwrap() == 42);
assert!(*array.get_element::<u8>(1).unwrap() == 43);
assert!(*array.get_element::<u8>(2).unwrap() == 44);

Trait Implementations

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

fn slice_data(
    data: impl Into<SharedData>,
    signature: impl Into<Signature>,
    format: EncodingFormat
) -> Result<SharedData, VariantError>

Get the slice of data that belongs to implementing type.

fn decode(
    data: impl Into<SharedData>,
    signature: impl Into<Signature>,
    format: EncodingFormat
) -> Result<Self, VariantError>

Decode instance of implementing type from the data slice.

fn ensure_correct_signature(
    signature: impl Into<Signature>
) -> Result<Signature, VariantError>

Ensure given signature is correct and of the implementing type.

fn slice_signature(
    signature: impl Into<Signature>
) -> Result<Signature, VariantError>

Get the slice of signature that belongs to implementing type.

fn take_from_variant(variant: Variant) -> Result<Self, VariantError>

Flatten the variant to enclosed value of the implementing type.

fn from_variant(variant: &Variant) -> Result<&Self, VariantError>

Flatten the variant reference to a reference of the enclosed value of the implementing type.

fn slice_for_decoding(
    data: impl Into<SharedData>,
    signature: impl Into<Signature>,
    format: EncodingFormat
) -> Result<SharedData, VariantError>

A helper for [decode] implementation. Removes any leading padding bytes.

impl Default for Array

fn default() -> Array

Returns the "default value" for a type.

impl Encode for Array

const SIGNATURE_CHAR: char

The signature charachter of the implementing type.

const SIGNATURE_STR: &'static str

The signature charachter of the implementing type, in string format.

const ALIGNMENT: usize

The alignment required for encoding of the implementing type, as number of bytes.

fn encode_into(&self, bytes: &mut Vec<u8>, format: EncodingFormat)

Encode self and append to the end of bytes buffer.

fn signature(&self) -> Signature

Get the signature.

fn to_variant(self) -> Variant

Unflatten self into a [Variant].

fn is(variant: &Variant) -> bool

Checks if variant value is of the generic type T.

fn encode(&self, format: EncodingFormat) -> Vec<u8>

Encode self into a new byte buffer and return it.

fn add_padding(bytes: &mut Vec<u8>, format: EncodingFormat)

Append required padding to bytes buffer.

fn padding(n_bytes_before: usize, _format: EncodingFormat) -> usize

The required padding for the implementing type.

impl From<Dict> for Array

fn from(value: Dict) -> Self

Performs the conversion.

impl<T> From<Vec<T>> for Array where
    T: Encode, 

fn from(values: Vec<T>) -> Self

Performs the conversion.

impl TryFrom<Array> for Dict

type Error = VariantError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a, T> TryInto<Vec<&'a T>> for &'a Array where
    T: Decode, 

type Error = VariantError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Vec<&'a T>, VariantError>

Performs the conversion.

impl<T> TryInto<Vec<T>> for Array where
    T: Decode, 

type Error = VariantError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Vec<T>, VariantError>

Performs the conversion.