Struct ByteArray 

#[repr(transparent)]
pub struct ByteArray(pub Vec<u8>);

A raw sequence of bytes whose length is supplied by context.

A ByteArray has no wire length prefix. Its meaning and number of bytes are determined by the enclosing packet or data structure, which supplies the length through Context::for_array_length or Context::with_array_length. It is encoded as exactly that many bytes:

byte[0] + byte[1] + ... + byte[length - 1]

This differs from PrefixedArray, which stores its own VarInt length, and from Array, which supports arbitrary contextual element codecs. ByteArray writes and reads its byte buffer in one operation and does not use array element contexts.

Examples

use mcproto_types::ContextualCodec;
use mcproto_types::contextual::{ByteArray, Context};

let value = ByteArray(vec![0xde, 0xad, 0xbe, 0xef]);
let context = Context::for_array_length(4);
let mut encoded = Vec::new();
value.encode_with_context(&mut encoded, &context)?;
assert_eq!(encoded, [0xde, 0xad, 0xbe, 0xef]);

let mut input = encoded.as_slice();
assert_eq!(ByteArray::decode_with_context(&mut input, &context)?, value);
assert!(input.is_empty());

Tuple Fields

0: Vec<u8>

The raw bytes.

Implementations

impl ByteArray

pub const fn new(bytes: Vec<u8>) -> Self

Creates a byte array from raw bytes.

pub const fn len(&self) -> usize

Returns the number of bytes.

pub const fn is_empty(&self) -> bool

Returns whether this byte array is empty.

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

Returns the bytes as a slice.

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

Extracts the underlying byte vector.

Trait Implementations

impl Clone for ByteArray

fn clone(&self) -> ByteArray

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ContextualCodec for ByteArray

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 Debug for ByteArray

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

Formats the value using the given formatter.

impl Default for ByteArray

fn default() -> ByteArray

Returns the “default value” for a type.

impl Eq for ByteArray

impl From<ByteArray> for Vec<u8>

fn from(bytes: ByteArray) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for ByteArray

fn from(bytes: Vec<u8>) -> Self

Converts to this type from the input type.

impl Hash for ByteArray

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 ByteArray

fn eq(&self, other: &ByteArray) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ByteArray