Enum nbt_lib::nbt_value::NbtValue

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

Enum storing NBT data

Variants

Byte(i8)

Data wrapper to store a signed 8-bit integer

Short(i16)

Data wrapper to store a signed 16-bit integer

Int(i32)

Data wrapper to store a signed 32-bit integer

Long(i64)

Data wrapper to store a signed 64-bit integer

Float(f32)

Data wrapper to store a signed 32-bit floating-point value

Double(f64)

Data wrapper to store a signed 64-bit floating-point value

ByteArray(Vec<i8>)

Data wrapper to store a list of signed 8-bit integers

String(String)

Data wrapper to store a string

List(Vec<NbtValue>)

Data wrapper to store a list of NBT values

Compound(Option<String>, HashMap<String, NbtValue>)

Data wrapper to store a named list of NBT values

Note

This struct can also have a name

IntArray(Vec<i32>)

Data wrapper to store a list of signed 32-bit integers

LongArray(Vec<i64>)

Data wrapper to store a list of signed 64-bit integers

Implementations

impl NbtValue

pub fn from_binary<R>(data: Vec<u8>) -> NbtResult<NbtValue>

where R: NbtRead,

function to convery a list of bytes into a NbtResult containing the read NbtValue

pub fn tag(&self) -> NbtTypeId

function to get the tag of the NbtValue

pub fn write_to<W>(&self, buff: &mut Vec<u8>) -> NbtResult<()>

where W: NbtWrite,

function to write nbt data to a type that implements NbtWrite

pub fn write_to_with_name<W>( &self, name: &str, buff: &mut Vec<u8> ) -> NbtResult<()>

where W: NbtWrite,

function to write nbt data with an name to a type that implements NbtWrite

pub fn to_binary<W>(&self) -> NbtResult<Vec<u8>>

where W: NbtWrite,

function to convert nbt data to a NbtResult containing a list of bytes, representing the nbt data

pub fn as_i8(&self) -> NbtResult<i8>

function to get the NbtValue as an i8

pub fn as_i16(&self) -> NbtResult<i16>

function to get the NbtValue as an i16

pub fn as_i32(&self) -> NbtResult<i32>

function to get the NbtValue as an i32

pub fn as_i64(&self) -> NbtResult<i64>

function to get the NbtValue as an i64

pub fn as_f32(&self) -> NbtResult<f32>

function to get the NbtValue as a f32

pub fn as_f64(&self) -> NbtResult<f64>

function to get the NbtValue as a f64

pub fn as_i8_array(&self) -> NbtResult<Vec<i8>>

function to get the NbtValue as a list of i8’s

pub fn as_i32_array(&self) -> NbtResult<Vec<i32>>

function to get the NbtValue as a list of i32’s

pub fn as_i64_array(&self) -> NbtResult<Vec<i64>>

function to get the NbtValue as a list of i64’s

pub fn as_string(&self) -> NbtResult<String>

function to get the NbtValue as a string

pub fn as_str(&self) -> NbtResult<&str>

function to get the NbtValue as a string

pub fn as_list(&self) -> NbtResult<Vec<NbtValue>>

function to get the NbtValue as a list of NbtValue’s

pub fn as_compound( &self ) -> NbtResult<(Option<&String>, HashMap<String, NbtValue>)>

function to get the NbtValue as a list of named NbtValue’s

pub fn is_i8(&self) -> bool

function to determine, if the NbtValue is a i8

pub fn is_i16(&self) -> bool

function to determine, if the NbtValue is a i16

pub fn is_i32(&self) -> bool

function to determine, if the NbtValue is a i32

pub fn is_i64(&self) -> bool

function to determine, if the NbtValue is a i64

pub fn is_f32(&self) -> bool

function to determine, if the NbtValue is a f32

pub fn is_f64(&self) -> bool

function to determine, if the NbtValue is a f64

pub fn is_i8_array(&self) -> bool

function to determine, if the NbtValue is a i8 array

pub fn is_i32_array(&self) -> bool

function to determine, if the NbtValue is a i32 array

pub fn is_i64_array(&self) -> bool

function to determine, if the NbtValue is a i64 array

pub fn is_string(&self) -> bool

function to determine, if the NbtValue is a String

pub fn is_list(&self) -> bool

function to determine, if the NbtValue is a List

pub fn is_compound(&self) -> bool

function to determine, if the NbtValue is a Compound

Trait Implementations

impl Clone for NbtValue

fn clone(&self) -> NbtValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NbtValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NbtValue

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> Deserializer<'de> for &'de NbtValue

type Error = Error

The error type that can be returned if some error occurs during deserialization.

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Error>

where V: Visitor<'de>,

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input.

fn deserialize_i8<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_u8<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_f32<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_i128<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u128<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an u128 value.

fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an optional value.

fn deserialize_enum<V>( self, _name: &str, _variants: &'static [&'static str], visitor: V ) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

fn deserialize_newtype_struct<V>( self, _name: &'static str, visitor: V ) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a newtype struct with a particular name.

fn deserialize_bool<V>(self, visitor: V) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a bool value.

fn deserialize_char<V>(self, visitor: V) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a char value.

fn deserialize_str<V>(self, visitor: V) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_string<V>(self, visitor: V) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_byte_buf<V>(self, visitor: V) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values.

fn deserialize_tuple<V>( self, _len: usize, visitor: V ) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data.

fn deserialize_tuple_struct<V>( self, _name: &'static str, _len: usize, visitor: V ) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.

fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a map of key-value pairs.

fn deserialize_struct<V>( self, _name: &'static str, _fields: &'static [&'static str], visitor: V ) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a struct with a particular name and fields.

fn deserialize_identifier<V>(self, visitor: V) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant.

fn deserialize_ignored_any<V>(self, visitor: V) -> Result<V::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored.

fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit value.

fn deserialize_unit_struct<V>( self, _name: &'static str, visitor: V ) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit struct with a particular name.

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form.

impl From<NbtValue> for NBT

fn from(value: NbtValue) -> Self

Converts to this type from the input type.

impl<'de> IntoDeserializer<'de, Error> for &'de NbtValue

type Deserializer = &'de NbtValue

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

impl PartialEq for NbtValue

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NbtValue

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl SizeOf for NbtValue

fn size_of(&self) -> usize

Get the size of a struct