Package net.fabricmc.fabric.api.transfer.v1.storage.base

Interface SingleSlotStorage<T>

Type Parameters:

T - The type of the stored resource. Experimental feature, we reserve the right to remove or change it without further notice. The transfer API is a complex addition, and we want to be able to correct possible design mistakes.

All Superinterfaces:

Storage<T>, StorageView<T>

All Known Implementing Classes:

FullItemFluidStorage, SingleFluidStorage, SingleStackStorage, SingleVariantItemStorage, SingleVariantStorage

@Experimental
public interface SingleSlotStorage<T>
extends Storage<T>, StorageView<T>

A storage that is also its only storage view. It can be used in APIs for storages that are wrappers around a single "slot", or for slightly more convenient implementation.

Method Summary

Modifier and Type	Method	Description
default Iterator<StorageView<T>>	iterator(TransactionContext transaction)	Iterate through the contents of this storage, for the scope of the passed transaction.

Methods inherited from interface net.fabricmc.fabric.api.transfer.v1.storage.Storage

exactView, extract, getVersion, insert, iterable, simulateExtract, simulateInsert, supportsExtraction, supportsInsertion

Methods inherited from interface net.fabricmc.fabric.api.transfer.v1.storage.StorageView

extract, getAmount, getCapacity, getResource, isResourceBlank

Method Details

iterator

default Iterator<StorageView<T>> iterator(TransactionContext transaction)

Description copied from interface: Storage

Iterate through the contents of this storage, for the scope of the passed transaction. Every visited StorageView represents a stored resource and an amount. The iterator doesn't guarantee that a single resource only occurs once during an iteration.

The returned iterator and any view it returns are only valid for the scope of to the passed transaction. They should not be used once that transaction is closed.

More precisely, as soon as the transaction is closed, hasNext() must return false, and any call to next() must throw a NoSuchElementException.

Storage.insert(T, long, net.fabricmc.fabric.api.transfer.v1.transaction.TransactionContext) and Storage.extract(T, long, net.fabricmc.fabric.api.transfer.v1.transaction.TransactionContext) may be called safely during iteration. Extractions should be visible to an open iterator, but insertions are not required to. In particular, inventories with a fixed amount of slots may wish to make insertions visible to iterators, but inventories with a dynamic or very large amount of slots should not do that to ensure timely termination of the iteration.

Specified by:

iterator in interface Storage<T>

Parameters:

transaction - The transaction to which the scope of the returned iterator is tied.

Returns:

An iterator over the contents of this storage.