Struct quartz_nbt::NbtList

#[repr(transparent)]
pub struct NbtList(_);

The NBT tag list type which is essentially just a wrapper for a vec of NBT tags.

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. See NbtTag for more details.

Implementations

impl NbtList

pub const fn new() -> Self

Returns a new NBT tag list with an empty internal vec.

pub fn inner_mut(&mut self) -> &mut Vec<NbtTag>

Returns a mutable reference to the internal vector of this NBT list.

pub fn into_inner(self) -> Vec<NbtTag>

Returns the internal vector of this NBT list.

pub fn with_capacity(capacity: usize) -> Self

Returns a new NBT tag list with the given initial capacity.

pub fn clone_from<'a, T, L>(list: L) -> Self where
    T: Clone + Into<NbtTag> + 'a,
    L: IntoIterator<Item = &'a T>, 

Clones the data in the given list and converts it into an NbtList.

Examples

let list: Vec<i32> = vec![1, 2, 3];
let nbt_list = NbtList::clone_from(&list);
assert_eq!(nbt_list.iter_map::<i32>().flatten().collect::<Vec<i32>>(), list);

pub fn clone_repr_from<'a, T, L>(list: L) -> Self where
    T: NbtRepr + 'a,
    L: IntoIterator<Item = &'a T>, 

Creates an NbtList of NbtCompounds by mapping each element in the given list to its NBT representation.

pub fn iter_map<'a, T: TryFrom<&'a NbtTag>>(
    &'a self
) -> impl Iterator<Item = Result<T, <T as TryFrom<&'a NbtTag>>::Error>> + 'a

Iterates over this tag list, converting each tag reference into the specified type.

Examples

let mut list = NbtList::new();
list.push(0i32);
list.push(1i32);
list.push(2.0f64);

let mut iter = list.iter_map::<i32>();
assert!(matches!(iter.next(), Some(Ok(0i32))));
assert!(matches!(iter.next(), Some(Ok(1i32))));
assert!(matches!(iter.next(), Some(Err(..)))); // Type mismatch
assert!(iter.next().is_none());

pub fn iter_mut_map<'a, T: TryFrom<&'a mut NbtTag>>(
    &'a mut self
) -> impl Iterator<Item = Result<T, <T as TryFrom<&'a mut NbtTag>>::Error>> + 'a

Iterates over mutable references to the tags in this list, converting each tag reference into the specified type. See iter_map for usage details.

pub fn to_snbt(&self) -> String

Converts this tag list to a valid SNBT string.

pub fn len(&self) -> usize

Returns the length of this list.

pub fn is_empty(&self) -> bool

Returns true if this tag list has a length of zero, false otherwise.

pub fn get<'a, T>(&'a self, index: usize) -> Result<T, NbtReprError> where
    T: TryFrom<&'a NbtTag>,
    T::Error: Into<Error>, 

Returns the value of the tag at the given index, or an error if the index is out of bounds or the the tag type does not match the type specified. This method should be used for obtaining primitives and shared references to lists and compounds.

let mut list = NbtList::clone_from(&vec![1i32, 2, 3]);

assert!(matches!(list.get::<i32>(0), Ok(1)));
assert!(list.get::<f64>(0).is_err()); // Type mismatch
assert!(list.get::<i32>(10).is_err()); // Invalid index

pub fn get_mut<'a, T>(&'a mut self, index: usize) -> Result<T, NbtReprError> where
    T: TryFrom<&'a mut NbtTag>,
    T::Error: Into<Error>, 

Returns a mutable reference to the tag at the given index, or an error if the index is out of bounds or tag type does not match the type specified. This method should be used for obtaining mutable references to elements.

let mut list = NbtList::clone_from(&vec![1i32, 2, 3]);

*list.get_mut::<&mut i32>(0).unwrap() += 1;

assert!(matches!(list.get::<i32>(0), Ok(2)));
assert!(list.get::<f64>(0).is_err()); // Type mismatch
assert!(list.get::<i32>(10).is_err()); // Invalid index

pub fn push<T: Into<NbtTag>>(&mut self, value: T)

Pushes the given value to the back of the list after wrapping it in an NbtTag.

let mut list = NbtList::new();

list.push(10i32);

assert!(matches!(list.get::<i32>(0), Ok(10)));
assert!(list.get::<f64>(0).is_err()); // Type mismatch
assert!(list.get::<i32>(10).is_err()); // Invalid index

Trait Implementations

impl AsMut<[NbtTag]> for NbtList

fn as_mut(&mut self) -> &mut [NbtTag]

Performs the conversion.

impl AsRef<[NbtTag]> for NbtList

fn as_ref(&self) -> &[NbtTag]

Performs the conversion.

impl Clone for NbtList

fn clone(&self) -> NbtList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NbtList

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NbtList

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

Deserialize this value from the given Serde deserializer.

impl Display for NbtList

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

Formats the value using the given formatter.

impl From<NbtList> for NbtTag

fn from(value: NbtList) -> NbtTag

Performs the conversion.

impl<T: Into<NbtTag>> From<Vec<T, Global>> for NbtList

fn from(list: Vec<T>) -> Self

Performs the conversion.

impl Index<usize> for NbtList

type Output = NbtTag

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for NbtList

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl PartialEq<NbtList> for NbtList

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

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

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

This method tests for !=.

impl Serialize for NbtList

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

Serialize this value into the given Serde serializer.

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 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 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 StructuralPartialEq for NbtList