Enum quartz_nbt::NbtTag

pub enum NbtTag {
    Byte(i8),
    Short(i16),
    Int(i32),
    Long(i64),
    Float(f32),
    Double(f64),
    ByteArray(Vec<i8>),
    String(String),
    List(NbtList),
    Compound(NbtCompound),
    IntArray(Vec<i32>),
    LongArray(Vec<i64>),
}

The generic NBT tag type, containing all supported tag variants which wrap around a corresponding rust type.

This type will implement both Serialize and Deserialize when the serde feature is enabled, however this type should still be read and written with the utilities in the io module when possible if speed is the main priority. When linking into the serde ecosystem, we ensured that all tag types would have their data inlined into the result NBT output of our Serializer. Because of this, NBT tags are only compatible with self-describing formats, and also have slower deserialization implementations due to this restriction.

Variants

Byte(i8)

A signed, one-byte integer.

Short(i16)

A signed, two-byte integer.

Int(i32)

A signed, four-byte integer.

Long(i64)

A signed, eight-byte integer.

Float(f32)

A 32-bit floating point value.

Double(f64)

A 64-bit floating point value.

ByteArray(Vec<i8>)

An array (vec) of one-byte integers. Minecraft treats this as an array of signed bytes.

String(String)

A UTF-8 string.

List(NbtList)

An NBT tag list.

Compound(NbtCompound)

An NBT tag compound.

IntArray(Vec<i32>)

An array (vec) of signed, four-byte integers.

LongArray(Vec<i64>)

An array (vec) of signed, eight-byte integers.

Implementations

impl NbtTag

pub fn type_specifier(&self) -> &str

Returns the single character denoting this tag’s type, or an empty string if this tag type has no type specifier.

Examples

assert_eq!(NbtTag::Long(10).type_specifier(), "L");
assert_eq!(NbtTag::String(String::new()).type_specifier(), "");

// Note that while integers do not require a type specifier, this method will still return "I"
assert_eq!(NbtTag::Int(-10).type_specifier(), "I");

pub fn to_snbt(&self) -> String

Converts this NBT tag into a valid, parsable SNBT string with no extraneous spacing. This method should not be used to generate user-facing text, rather to_component should be used instead.

Examples

Simple primitive conversion:

assert_eq!(NbtTag::Byte(5).to_snbt(), "5B");
assert_eq!(NbtTag::String("\"Quoted text\"".to_owned()).to_snbt(), "'\"Quoted text\"'");

More complex tag conversion:

let mut compound = NbtCompound::new();
compound.insert("foo".to_owned(), vec![-1_i64, -3_i64, -5_i64]);
assert_eq!(NbtTag::Compound(compound).to_snbt(), "{foo:[L;-1,-3,-5]}");

pub fn should_quote(string: &str) -> bool

Returns whether or not the given string needs to be quoted due to non-alphanumeric or otherwise non-standard characters.

pub fn string_to_snbt(string: &str) -> String

Wraps the given string in quotes and escapes any quotes contained in the original string.

Trait Implementations

impl Clone for NbtTag

fn clone(&self) -> NbtTag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NbtTag

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NbtTag

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for NbtTag

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

Formats the value using the given formatter.

impl From<&'_ String> for NbtTag

fn from(value: &String) -> NbtTag

Performs the conversion.

impl From<&'_ str> for NbtTag

fn from(value: &str) -> NbtTag

Performs the conversion.

impl From<NbtCompound> for NbtTag

fn from(value: NbtCompound) -> NbtTag

Performs the conversion.

impl From<NbtList> for NbtTag

fn from(value: NbtList) -> NbtTag

Performs the conversion.

impl From<String> for NbtTag

fn from(value: String) -> NbtTag

Performs the conversion.

impl<T: NbtRepr> From<T> for NbtTag

fn from(x: T) -> Self

Performs the conversion.

impl From<Vec<i32, Global>> for NbtTag

fn from(value: Vec<i32>) -> NbtTag

Performs the conversion.

impl From<Vec<i64, Global>> for NbtTag

fn from(value: Vec<i64>) -> NbtTag

Performs the conversion.

impl From<Vec<i8, Global>> for NbtTag

fn from(value: Vec<i8>) -> NbtTag

Performs the conversion.

impl From<Vec<u8, Global>> for NbtTag

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

Performs the conversion.

impl From<bool> for NbtTag

fn from(value: bool) -> NbtTag

Performs the conversion.

impl From<f32> for NbtTag

fn from(value: f32) -> NbtTag

Performs the conversion.

impl From<f64> for NbtTag

fn from(value: f64) -> NbtTag

Performs the conversion.

impl From<i16> for NbtTag

fn from(value: i16) -> NbtTag

Performs the conversion.

impl From<i32> for NbtTag

fn from(value: i32) -> NbtTag

Performs the conversion.

impl From<i64> for NbtTag

fn from(value: i64) -> NbtTag

Performs the conversion.

impl From<i8> for NbtTag

fn from(value: i8) -> NbtTag

Performs the conversion.

impl From<u8> for NbtTag

fn from(value: u8) -> Self

Performs the conversion.

impl PartialEq<NbtTag> for NbtTag

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for NbtTag

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ NbtTag> for i8

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ NbtTag> for i16

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ NbtTag> for i32

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ NbtTag> for i64

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ NbtTag> for f32

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ NbtTag> for f64

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ NbtTag> for bool

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ NbtTag> for u8

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a i8

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a i16

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a NbtList

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a NbtCompound

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a Vec<i32>

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a [i32]

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a Vec<i64>

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a [i64]

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a u8

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a [u8]

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a i32

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a i64

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a f32

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a f64

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a Vec<i8>

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a [i8]

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a String

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a NbtTag> for &'a str

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut i8

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut i16

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut NbtList

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut NbtCompound

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut Vec<i32>

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut [i32]

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut Vec<i64>

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut [i64]

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut i32

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut i64

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut f32

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut f64

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut Vec<i8>

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut [i8]

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut String

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut NbtTag> for &'a mut str

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: &'a mut NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NbtTag> for i8

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NbtTag> for i16

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NbtTag> for Vec<i32>

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NbtTag> for Vec<i64>

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NbtTag> for Vec<u8>

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NbtTag> for i32

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NbtTag> for i64

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NbtTag> for f32

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NbtTag> for f64

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NbtTag> for Vec<i8>

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NbtTag> for String

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NbtTag> for NbtList

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NbtTag> for NbtCompound

type Error = NbtStructureError

The type returned in the event of a conversion error.

fn try_from(tag: NbtTag) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for NbtTag