Struct Identifier 

pub struct Identifier {
    pub namespace: String,
    pub path: String,
}

A namespaced identifier in the format namespace:path.

Identifiers (also called ResourceLocations) are used throughout the Minecraft protocol to reference game content: blocks (minecraft:stone), items (minecraft:diamond), entities (minecraft:creeper), dimensions (minecraft:overworld), registries, and plugin channels. They are encoded on the wire as a single VarInt-prefixed UTF-8 string in the format namespace:path.

The namespace defaults to minecraft when absent. Valid characters are:

• Namespace: [a-z0-9._-]
• Path: [a-z0-9._-/]

Fields

namespace: String

The namespace part (e.g., minecraft, mymod).

path: String

The path part (e.g., stone, textures/block/dirt).

Implementations

impl Identifier

pub fn new( namespace: impl Into<String>, path: impl Into<String>, ) -> Result<Self>

Creates a new identifier with the given namespace and path.

Validates that both namespace and path contain only allowed characters. Returns Error::InvalidData if validation fails.

pub fn minecraft(path: impl Into<String>) -> Result<Self>

Creates a new identifier under the minecraft namespace.

This is a convenience for the most common case, since the majority of identifiers in the protocol use the minecraft namespace.

pub fn as_str(&self) -> String

👎Deprecated:

use Display impl via to_string() instead

Returns the full identifier string in namespace:path format.

Note: this allocates a new String. For zero-cost display, use the Display impl via format!("{id}") or id.to_string().

Trait Implementations

impl Clone for Identifier

fn clone(&self) -> Identifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Identifier

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

Formats the value using the given formatter.

impl Decode for Identifier

Decodes an Identifier from a VarInt-prefixed UTF-8 string.

Reads the string using the standard Minecraft string decoding, then parses it as namespace:path. If no colon is present, the namespace defaults to minecraft. Validates that all characters are in the allowed sets for namespace and path.

fn decode(buf: &mut &[u8]) -> Result<Self>

Reads a protocol string and parses it as an identifier.

Fails with Error::InvalidData if the identifier contains invalid characters or is empty. Also inherits string decoding errors (buffer underflow, string too long, invalid UTF-8).

impl Display for Identifier

Displays the identifier in namespace:path format.

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

Formats the value using the given formatter.

impl Encode for Identifier

Encodes an Identifier as a VarInt-prefixed UTF-8 string in namespace:path format.

The full namespace:path string is written using the standard Minecraft string encoding (VarInt length prefix + UTF-8 bytes). This is the same wire format used for all string fields in the protocol.

fn encode(&self, buf: &mut Vec<u8>) -> Result<()>

Writes the identifier as a VarInt-prefixed namespace:path string.

impl EncodedSize for Identifier

Computes the wire size of the identifier in namespace:path format.

The total size includes the VarInt length prefix and the full namespace:path UTF-8 byte count (including the colon separator).

fn encoded_size(&self) -> usize

Returns the VarInt prefix size plus the byte length of namespace:path.

impl Eq for Identifier

impl Hash for Identifier

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 Identifier

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Identifier