Enum Value

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

Represents an arbitrary NBT value.

Variants

Byte(i8)

Short(i16)

Int(i32)

Long(i64)

Float(f32)

Double(f64)

ByteArray(Vec<i8>)

String(S)

List(List<S>)

Compound(Compound<S>)

IntArray(Vec<i32>)

LongArray(Vec<i64>)

Implementations

impl<S> Value<S>

pub fn tag(&self) -> Tag

Returns the type of this value.

pub fn is_number(&self) -> bool

Returns whether this value is a number, i.e. a byte, short, int, long, float or double.

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

If this value is a number, returns the i8 representation of this value.

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

If this value is a number, returns the i16 representation of this value.

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

If this value is a number, returns the i32 representation of this value.

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

If this value is a number, returns the i64 representation of this value.

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

If this value is a number, returns the f32 representation of this value.

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

If this value is a number, returns the f64 representation of this value.

pub fn as_bool(&self) -> Option<bool>

If this value is a number, returns the bool representation of this value.

impl<S> Value<S>

pub fn as_value_ref(&self) -> ValueRef<'_, S>

Converts a reference to a value to a ValueRef.

pub fn as_value_mut(&mut self) -> ValueMut<'_, S>

Converts a mutable reference to a value to a ValueMut.

Trait Implementations

impl<S: Clone> Clone for Value<S>

fn clone(&self) -> Value<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Value<S>

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

Formats the value using the given formatter.

impl<'de, S> Deserialize<'de> for Value<S>

where S: Deserialize<'de> + Ord + Hash,

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 Value

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, Self::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_bool<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a bool value.

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

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an optional value.

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

where V: Visitor<'de>,

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

fn deserialize_i8<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i64 value.

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

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u8<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u64 value.

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

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an u128 value.

fn deserialize_f32<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::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 as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_char<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::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, <Self as Deserializer<'de>>::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, <Self as Deserializer<'de>>::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, <Self as Deserializer<'de>>::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, <Self as Deserializer<'de>>::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_unit<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::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 as Deserializer<'de>>::Error>

where V: Visitor<'de>,

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

fn deserialize_newtype_struct<V>( self, name: &'static str, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

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

fn deserialize_seq<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::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, <Self as Deserializer<'de>>::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, <Self as Deserializer<'de>>::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, <Self as Deserializer<'de>>::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, <Self as Deserializer<'de>>::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, <Self as Deserializer<'de>>::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, <Self as Deserializer<'de>>::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 is_human_readable(&self) -> bool

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

impl<'a> From<&'a JavaStr> for Value<Cow<'a, JavaStr>>

fn from(v: &'a JavaStr) -> Self

Converts to this type from the input type.

impl<'a> From<&'a JavaStr> for Value<JavaString>

fn from(v: &'a JavaStr) -> Self

Converts to this type from the input type.

impl<'a> From<&'a JavaString> for Value<Cow<'a, JavaStr>>

fn from(v: &'a JavaString) -> Self

Converts to this type from the input type.

impl From<&JavaString> for Value<JavaString>

fn from(v: &JavaString) -> Self

Converts to this type from the input type.

impl From<&String> for Value<String>

fn from(value: &String) -> Self

Converts to this type from the input type.

impl<'a> From<&'a String> for Value<Cow<'a, JavaStr>>

fn from(v: &'a String) -> Self

Converts to this type from the input type.

impl<'a> From<&'a String> for Value<Cow<'a, str>>

fn from(v: &'a String) -> Self

Converts to this type from the input type.

impl From<&String> for Value<JavaString>

fn from(v: &String) -> Self

Converts to this type from the input type.

impl<'a, S> From<&'a Value<S>> for ValueRef<'a, S>

fn from(v: &'a Value<S>) -> Self

Converts to this type from the input type.

impl<S> From<&ValueMut<'_, S>> for Value<S>

where S: Clone,

fn from(v: &ValueMut<'_, S>) -> Self

Converts to this type from the input type.

impl<S> From<&ValueRef<'_, S>> for Value<S>

where S: Clone,

fn from(v: &ValueRef<'_, S>) -> Self

Converts to this type from the input type.

impl<'a, S> From<&'a mut Value<S>> for ValueMut<'a, S>

fn from(v: &'a mut Value<S>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for Value<String>

fn from(v: &'a str) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for Value<Cow<'a, JavaStr>>

fn from(v: &'a str) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for Value<Cow<'a, str>>

fn from(v: &'a str) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for Value<JavaString>

fn from(v: &'a str) -> Self

Converts to this type from the input type.

impl<S> From<Compound<S>> for Value<S>

fn from(v: Compound<S>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, JavaStr>> for Value<Cow<'a, JavaStr>>

fn from(v: Cow<'a, JavaStr>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, JavaStr>> for Value<JavaString>

fn from(v: Cow<'a, JavaStr>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for Value<String>

fn from(v: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for Value<Cow<'a, JavaStr>>

fn from(v: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for Value<Cow<'a, str>>

fn from(v: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for Value<JavaString>

fn from(v: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl<I, S> From<Ident<I>> for Value<S>

where I: Into<Value<S>>,

fn from(value: Ident<I>) -> Self

Converts to this type from the input type.

impl From<JavaString> for Value<Cow<'_, JavaStr>>

fn from(v: JavaString) -> Self

Converts to this type from the input type.

impl From<JavaString> for Value<JavaString>

fn from(v: JavaString) -> Self

Converts to this type from the input type.

impl<S> From<List<S>> for Value<S>

fn from(v: List<S>) -> Self

Converts to this type from the input type.

impl From<String> for Value<String>

fn from(v: String) -> Self

Converts to this type from the input type.

impl From<String> for Value<Cow<'_, JavaStr>>

fn from(v: String) -> Self

Converts to this type from the input type.

impl From<String> for Value<Cow<'_, str>>

fn from(v: String) -> Self

Converts to this type from the input type.

impl From<String> for Value<JavaString>

fn from(v: String) -> Self

Converts to this type from the input type.

impl<S> From<Uuid> for Value<S>

fn from(value: Uuid) -> Self

Converts to this type from the input type.

impl<S> From<Value<S>> for List<S>

Converts a value to a singleton list.

fn from(value: Value<S>) -> Self

Converts to this type from the input type.

impl<S> From<ValueMut<'_, S>> for Value<S>

where S: Clone,

fn from(v: ValueMut<'_, S>) -> Self

Converts to this type from the input type.

impl<S> From<ValueRef<'_, S>> for Value<S>

where S: Clone,

fn from(v: ValueRef<'_, S>) -> Self

Converts to this type from the input type.

impl<S> From<Vec<i32>> for Value<S>

fn from(v: Vec<i32>) -> Self

Converts to this type from the input type.

impl<S> From<Vec<i64>> for Value<S>

fn from(v: Vec<i64>) -> Self

Converts to this type from the input type.

impl<S> From<Vec<i8>> for Value<S>

fn from(v: Vec<i8>) -> Self

Converts to this type from the input type.

impl<S> From<bool> for Value<S>

Bools are usually represented as 0 or 1 bytes in NBT.

fn from(b: bool) -> Self

Converts to this type from the input type.

impl<S> From<f32> for Value<S>

fn from(v: f32) -> Self

Converts to this type from the input type.

impl<S> From<f64> for Value<S>

fn from(v: f64) -> Self

Converts to this type from the input type.

impl<S> From<i16> for Value<S>

fn from(v: i16) -> Self

Converts to this type from the input type.

impl<S> From<i32> for Value<S>

fn from(v: i32) -> Self

Converts to this type from the input type.

impl<S> From<i64> for Value<S>

fn from(v: i64) -> Self

Converts to this type from the input type.

impl<S> From<i8> for Value<S>

fn from(v: i8) -> Self

Converts to this type from the input type.

impl IntoDeserializer<'_, Error> for Value

type Deserializer = Value

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

impl<S> PartialEq for Value<S>

where S: Ord + Hash,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<Str> Serialize for Value<Str>

where Str: Serialize + Ord + Hash,

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

where S: Serializer,

Serialize this value into the given Serde serializer.