Enum valence_nbt::value::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 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, str>>

fn from(v: &'a 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, str>>

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, 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, str>>

fn from(v: Cow<'a, str>) -> 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<'_, str>>

fn from(v: String) -> 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<S> PartialEq for Value<S>

where S: Ord + Hash,

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.