Skip to main content

NbtList

Struct NbtList 

Source
pub struct NbtList {
    pub element_type: u8,
    pub elements: Vec<NbtTag>,
}
Expand description

A homogeneous ordered list of NBT tags.

All elements in an NBT list must have the same tag type. The wire format encodes the element type once (as a single byte), followed by the count (as a big-endian i32), then each element’s payload without type bytes or names. An empty list uses End (0) as the element type.

Fields§

§element_type: u8

The tag type ID shared by all elements. For empty lists, this is tag_id::END (0).

§elements: Vec<NbtTag>

The list elements. All must have a tag_id() matching element_type, or element_type must be tag_id::END when the list is empty.

Implementations§

Source§

impl NbtList

Source

pub fn new() -> Self

Creates a new empty NBT list.

The element type is set to End (0), which is the standard encoding for empty lists in the NBT format.

Source

pub fn from_tags(tags: Vec<NbtTag>) -> Option<Self>

Creates an NBT list from a vector of tags.

All tags must have the same type. The element type is inferred from the first element. Returns None if the tags have mixed types. Returns an empty list with End element type if the vector is empty.

Source

pub fn len(&self) -> usize

Returns the number of elements in the list.

Source

pub fn is_empty(&self) -> bool

Returns true if the list contains no elements.

Trait Implementations§

Source§

impl Clone for NbtList

Source§

fn clone(&self) -> NbtList

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NbtList

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for NbtList

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for NbtList

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for NbtList

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.