Struct EntityMetadata 

pub struct EntityMetadata { /* private fields */ }

A complete 0xff-terminated entity metadata sequence.

Entry indices are unique and can only be in 0..=254; the list codec always appends 0xff and consumes no bytes after that terminator. Metadata fields may be omitted, so an empty value is encoded as the terminator alone.

Examples

use mcproto_types::{
    Byte, EntityMetadata, EntityMetadataEntry, EntityMetadataValue, TypeCodec,
};

let metadata = EntityMetadata::new(vec![EntityMetadataEntry::try_new(
    0,
    EntityMetadataValue::Byte(Byte(0x20)),
)?])?;

let mut encoded = Vec::new();
metadata.encode(&mut encoded)?;
assert_eq!(encoded, [0x00, 0x00, 0x20, 0xff]);

let mut input = encoded.as_slice();
assert_eq!(EntityMetadata::decode(&mut input)?, metadata);
assert!(input.is_empty());

See the official Entity Metadata Format documentation.

Implementations

impl EntityMetadata

pub fn new( entries: Vec<EntityMetadataEntry>, ) -> Result<Self, DuplicateEntityMetadataIndex>

Creates a metadata sequence after checking that all indices are unique.

pub fn entries(&self) -> &[EntityMetadataEntry]

Returns the entries in wire order.

pub fn into_entries(self) -> Vec<EntityMetadataEntry>

Extracts the entries in wire order.

pub const fn len(&self) -> usize

Returns the number of metadata entries, excluding the terminator.

pub const fn is_empty(&self) -> bool

Returns whether this sequence contains no entries.

pub fn get(&self, index: EntityMetadataIndex) -> Option<&EntityMetadataEntry>

Returns the entry at index, if present.

pub fn push( &mut self, entry: EntityMetadataEntry, ) -> Result<(), DuplicateEntityMetadataIndex>

Appends an entry if its index is not already present.

Trait Implementations

impl Clone for EntityMetadata

fn clone(&self) -> EntityMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityMetadata

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

Formats the value using the given formatter.

impl Default for EntityMetadata

fn default() -> EntityMetadata

Returns the “default value” for a type.

impl PartialEq for EntityMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EntityMetadata

impl TypeCodec for EntityMetadata

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.