Struct Array 

#[repr(transparent)]
pub struct Array<T>(pub Vec<T>);

A sequence of protocol values whose element count is supplied by context.

Array<T> has no wire length prefix. The enclosing packet must supply the number of elements through Context::for_array_length or Context::with_array_length. Exactly that many values are encoded or decoded. A zero length therefore produces and consumes zero bytes.

The total byte size is not necessarily length * fixed_size: if T has a variable-size encoding, each element may occupy a different number of bytes.

Examples

use mcproto_types::{ContextualCodec, TypeCodec, basic::UnsignedByte};
use mcproto_types::contextual::{Array, Context};

let values = Array(vec![UnsignedByte(1), UnsignedByte(2)]);
let mut encoded = Vec::new();
values.encode_with_context(&mut encoded, &Context::for_array_length(2))?;
assert_eq!(encoded, [1, 2]);

let mut input = encoded.as_slice();
assert_eq!(
    Array::<UnsignedByte>::decode_with_context(
        &mut input,
        &Context::for_array_length(2),
    )?,
    values,
);

Tuple Fields

0: Vec<T>

The array elements.

Implementations

impl<T> Array<T>

pub const fn new(values: Vec<T>) -> Self

Creates an array from its elements.

pub const fn len(&self) -> usize

Returns the number of elements.

pub const fn is_empty(&self) -> bool

Returns whether the array contains no elements.

pub const fn as_slice(&self) -> &[T]

Returns the elements as a slice.

pub fn into_vec(self) -> Vec<T>

Extracts the underlying vector.

Trait Implementations

impl<T: Clone> Clone for Array<T>

fn clone(&self) -> Array<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> ContextualCodec for Array<T>

where T: ContextualCodec,

fn encode_with_context( &self, writer: &mut impl Write, context: &Context, ) -> Result<(), CodecError>

Encodes this value using context supplied by its enclosing structure.

fn decode_with_context( reader: &mut impl Read, context: &Context, ) -> Result<Self, CodecError>

Decodes this value using context supplied by its enclosing structure.

impl<T: Debug> Debug for Array<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Array<T>

fn default() -> Array<T>

Returns the “default value” for a type.

impl<T: Eq> Eq for Array<T>

impl<T> From<Array<T>> for Vec<T>

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

Converts to this type from the input type.

impl<T> From<Vec<T>> for Array<T>

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

Converts to this type from the input type.

impl<T: Hash> Hash for Array<T>

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<T: PartialEq> PartialEq for Array<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for Array<T>