Struct ItemStack 

pub struct ItemStack {
    pub item: ItemKind,
    pub count: i8,
    /* private fields */
}

A stack of items in an inventory.

Fields

item: ItemKind

count: i8

Implementations

impl ItemStack

pub const EMPTY: ItemStack

pub const fn new(item: ItemKind, count: i8) -> ItemStack

Creates a new item stack without any components.

pub fn new_vanilla(item: ItemKind, count: i8) -> ItemStack

Creates a new item stack with the vanilla default components for the given ItemKind.

pub fn components(&self) -> Vec<&ItemComponent>

Read the components of the item stack.

pub fn default_components(&self) -> Vec<ItemComponent>

Returns the default components for the ItemKind.

pub fn insert_component(&mut self, component: ItemComponent)

Attach a component to the item stack.

pub fn remove_component<I>(&mut self, id: I) -> Option<ItemComponent>

where I: Into<usize>,

Remove a component from the item stack by its ID, see [ItemComponent::id].String

Returns the removed component if it was present, otherwise None.

pub fn get_component<I>(&self, id: I) -> Option<&ItemComponent>

where I: Into<usize>,

Get a specific component by its ID, see [ItemComponent::id].

pub const fn with_count(self, count: i8) -> ItemStack

pub const fn with_item(self, item: ItemKind) -> ItemStack

pub fn with_components(self, components: Vec<ItemComponent>) -> ItemStack

pub const fn is_empty(&self) -> bool

pub fn is_same_item_kind_and_same_components(&self, other: &ItemStack) -> bool

Returns true if self and other are the same item kind with the same component data. Counts are ignored.

pub fn encode_recursive<W>(&self, w: W, prefixed: bool) -> Result<(), Error>

where W: Write,

Trait Implementations

impl Clone for ItemStack

fn clone(&self) -> ItemStack

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ItemStack

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

Formats the value using the given formatter.

impl<'a> Decode<'a> for ItemStack

fn decode(r: &mut &'a [u8]) -> Result<ItemStack, Error>

Reads this object from the provided byte slice.

impl Default for ItemStack

fn default() -> ItemStack

Returns the “default value” for a type.

impl Encode for ItemStack

fn encode(&self, w: impl Write) -> Result<(), Error>

Writes this object to the provided writer.

fn encode_slice(slice: &[Self], w: impl Write) -> Result<(), Error>

where Self: Sized,

Like [Encode::encode], except that a whole slice of values is encoded.

impl PartialEq for ItemStack

fn eq(&self, other: &ItemStack) -> 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 StructuralPartialEq for ItemStack