Enum valence::nbt::list::List

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

An NBT list value.

NBT lists are homogeneous, meaning each list element must be of the same type. This is opposed to a format like JSON where lists can be heterogeneous. Here is a JSON list that would be illegal in NBT:

[42, "hello", {}]

Every possible element type has its own variant in this enum. As a result, heterogeneous lists are unrepresentable.

Variants

End

The list with the element type of TAG_End and length of zero.

Byte(Vec<i8>)

Short(Vec<i16>)

Int(Vec<i32>)

Long(Vec<i64>)

Float(Vec<f32>)

Double(Vec<f64>)

ByteArray(Vec<Vec<i8>>)

String(Vec<S>)

List(Vec<List<S>>)

Compound(Vec<Compound<S>>)

IntArray(Vec<Vec<i32>>)

LongArray(Vec<Vec<i64>>)

Implementations

impl<S> List<S>

pub fn new() -> List<S>

Constructs a new empty NBT list, with the element type of TAG_End.

pub fn len(&self) -> usize

Returns the length of this list.

pub fn is_empty(&self) -> bool

Returns true if this list has no elements. false otherwise.

pub fn element_tag(&self) -> Tag

Returns the element type of this list.

pub fn get(&self, index: usize) -> Option<ValueRef<'_, S>>

Gets a reference to the value at the given index in this list, or None if the index is out of bounds.

pub fn get_mut(&mut self, index: usize) -> Option<ValueMut<'_, S>>

Gets a mutable reference to the value at the given index in this list, or None if the index is out of bounds.

pub fn try_push<V>(&mut self, value: V) -> bool

where V: Into<Value<S>>,

Attempts to add the given value to the end of this list, failing if adding the value would result in the list not being heterogeneous (have multiple types inside it). Returns true if the value was added, false otherwise.

pub fn try_insert<V>(&mut self, index: usize, value: V) -> bool

where V: Into<Value<S>>,

Attempts to insert the given value at the given index in this list, failing if adding the value would result in the list not being heterogeneous (have multiple types inside it). Returns true if the value was added, false otherwise.

Panics

Panics if the index is greater than the length of the list.

pub fn remove(&mut self, index: usize) -> Value<S>

Removes the element at the given index in the list, and returns the value removed.

Panics

Panics if index is out of bounds.

pub fn retain<F>(&mut self, f: F)

where F: FnMut(ValueMut<'_, S>) -> bool,

Returns only the elements specified by the predicate, passing a mutable reference to it.

In other words, removes all elements e such that f(ValueMut(&mut e)) returns false. This method operates in place, visiting each element exactly once in the original order, and preserves the order of the retained elements.

pub fn iter(&self) -> Iter<'_, S>

Returns an iterator over this list. This iterator yields ValueRefs.

pub fn iter_mut(&mut self) -> IterMut<'_, S>

Returns a mutable iterator over this list. This iterator yields ValueMuts.

Trait Implementations

impl<S> Clone for List<S>

where S: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for List<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<S> Default for List<S>

fn default() -> List<S>

Returns the “default value” for a type.

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

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

fn deserialize<D>( deserializer: D, ) -> Result<List<S>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> Deserializer<'de> for List

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 as Visitor<'de>>::Value, <List as Deserializer<'de>>::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 as Visitor<'de>>::Value, <List as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a bool value.

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

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an optional value.

fn deserialize_unit<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <List 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 as Visitor<'de>>::Value, <List 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 as Visitor<'de>>::Value, <List 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 as Visitor<'de>>::Value, <List 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 as Visitor<'de>>::Value, <List 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 as Visitor<'de>>::Value, <List 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 as Visitor<'de>>::Value, <List 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 as Visitor<'de>>::Value, <List 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_enum<V>( self, name: &'static str, variants: &'static [&'static str], visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <List as Deserializer<'de>>::Error>

where V: Visitor<'de>,

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

fn deserialize_identifier<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <List 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 as Visitor<'de>>::Value, <List 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, S> From<&'a List<S>> for ValueRef<'a, S>

fn from(v: &'a List<S>) -> ValueRef<'a, S>

Converts to this type from the input type.

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

fn from(v: &'a mut List<S>) -> ValueMut<'a, S>

Converts to this type from the input type.

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

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

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>) -> List<S>

Converts to this type from the input type.

impl<S> From<Vec<Compound<S>>> for List<S>

fn from(v: Vec<Compound<S>>) -> List<S>

Converts to this type from the input type.

impl<'a> From<Vec<Cow<'a, JavaStr>>> for List<Cow<'a, JavaStr>>

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

Converts to this type from the input type.

impl<'a> From<Vec<Cow<'a, str>>> for List<Cow<'a, str>>

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

Converts to this type from the input type.

impl From<Vec<JavaString>> for List<JavaString>

fn from(v: Vec<JavaString>) -> List<JavaString>

Converts to this type from the input type.

impl<S> From<Vec<List<S>>> for List<S>

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

Converts to this type from the input type.

impl From<Vec<String>> for List

fn from(v: Vec<String>) -> List

Converts to this type from the input type.

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

fn from(v: Vec<Vec<i32>>) -> List<S>

Converts to this type from the input type.

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

fn from(v: Vec<Vec<i64>>) -> List<S>

Converts to this type from the input type.

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

fn from(v: Vec<Vec<i8>>) -> List<S>

Converts to this type from the input type.

impl<S> From<Vec<f32>> for List<S>

fn from(v: Vec<f32>) -> List<S>

Converts to this type from the input type.

impl<S> From<Vec<f64>> for List<S>

fn from(v: Vec<f64>) -> List<S>

Converts to this type from the input type.

impl<S> From<Vec<i16>> for List<S>

fn from(v: Vec<i16>) -> List<S>

Converts to this type from the input type.

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

fn from(v: Vec<i32>) -> List<S>

Converts to this type from the input type.

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

fn from(v: Vec<i64>) -> List<S>

Converts to this type from the input type.

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

fn from(v: Vec<i8>) -> List<S>

Converts to this type from the input type.

impl<'de> IntoDeserializer<'de, Error> for List

type Deserializer = List

The type of the deserializer being converted into.

fn into_deserializer( self, ) -> <List as IntoDeserializer<'de, Error>>::Deserializer

Convert this value into a deserializer.

impl<'a, S> IntoIterator for &'a List<S>

type Item = ValueRef<'a, S>

The type of the elements being iterated over.

type IntoIter = Iter<'a, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a List<S> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, S> IntoIterator for &'a mut List<S>

type Item = ValueMut<'a, S>

The type of the elements being iterated over.

type IntoIter = IterMut<'a, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut List<S> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<S> IntoIterator for List<S>

type Item = Value<S>

The type of the elements being iterated over.

type IntoIter = IntoIter<S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <List<S> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<S> PartialEq for List<S>

where S: Ord + Hash,

fn eq(&self, other: &List<S>) -> 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 List<Str>

where Str: Serialize + Ord + Hash,

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

where S: Serializer,

Serialize this value into the given Serde serializer.