Struct EntityMetadataIndex 

pub struct EntityMetadataIndex(/* private fields */);

A valid entity metadata index in the inclusive range 0..=254.

Byte value 0xff cannot be constructed because it terminates the complete EntityMetadata sequence.

Implementations

impl EntityMetadataIndex

pub const MAX: u8 = 0xfe

Largest index available to an entry.

pub const TERMINATOR: u8 = 0xff

Reserved byte that terminates an entity metadata sequence.

pub const fn new(index: u8) -> Result<Self, InvalidEntityMetadataIndex>

Creates a valid metadata index.

pub const fn get(self) -> u8

Returns the raw unsigned-byte index.

Trait Implementations

impl Clone for EntityMetadataIndex

fn clone(&self) -> EntityMetadataIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EntityMetadataIndex

impl Debug for EntityMetadataIndex

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

Formats the value using the given formatter.

impl Eq for EntityMetadataIndex

impl From<EntityMetadataIndex> for u8

fn from(value: EntityMetadataIndex) -> Self

Converts to this type from the input type.

impl Hash for EntityMetadataIndex

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 Ord for EntityMetadataIndex

fn cmp(&self, other: &EntityMetadataIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for EntityMetadataIndex

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for EntityMetadataIndex

fn partial_cmp(&self, other: &EntityMetadataIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for EntityMetadataIndex

impl TryFrom<u8> for EntityMetadataIndex

type Error = InvalidEntityMetadataIndex

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl TypeCodec for EntityMetadataIndex

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.