Struct PrefixedArray 

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

A sequence prefixed by its element count as a VarInt.

The Minecraft protocol Prefixed Array wire representation is a non-negative VarInt length followed by exactly that many T values:

VarInt(length) + T[0] + T[1] + ... + T[length - 1]

A zero length is encoded as 0x00 and has no element payload. Since the prefix is a signed 32-bit VarInt, arrays cannot contain more than 2,147,483,647 elements. This type supports all context-independent protocol values through T: TypeCodec.

Examples

use mcproto_types::{TypeCodec, basic::UnsignedByte};
use mcproto_types::contextual::PrefixedArray;

let values = PrefixedArray(vec![UnsignedByte(1), UnsignedByte(2)]);
let mut encoded = Vec::new();
values.encode(&mut encoded)?;
assert_eq!(encoded, [0x02, 0x01, 0x02]);

let mut input = encoded.as_slice();
assert_eq!(PrefixedArray::<UnsignedByte>::decode(&mut input)?, values);
assert!(input.is_empty());

Tuple Fields

0: Vec<T>

The array elements.

Implementations

impl<T> PrefixedArray<T>

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

Creates a length-prefixed 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 PrefixedArray<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PrefixedArray<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for PrefixedArray<T>

fn default() -> PrefixedArray<T>

Returns the “default value” for a type.

impl<T: Eq> Eq for PrefixedArray<T>

impl<T> From<PrefixedArray<T>> for Vec<T>

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

Converts to this type from the input type.

impl<T> From<Vec<T>> for PrefixedArray<T>

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

Converts to this type from the input type.

impl<T: Hash> Hash for PrefixedArray<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 PrefixedArray<T>

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

Equality operator ==.

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

Inequality operator !=.

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

impl<T> TypeCodec for PrefixedArray<T>

where T: TypeCodec,

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

Encodes this value to the writer.

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

Decodes this value from the reader.