mirror of
https://github.com/luxfi/util.git
synced 2026-10-30 15:13:56 +00:00
zeekayandHanzo Dev
b45161c43f
These three sit in luxfi/node under utils/, and P-Chain and X-Chain reach for them. Both chains have to leave that repository before it can be archived, and a chain should not have to depend on a node to measure a quantity in nLUX, keep a heap, or walk a sequence. units imports nothing at all; heap wanted only Zero, which is already here; iterator wanted heap and Zero. Three of iterator's tests exercise it against platformvm's state iterators. They stay with the node, and travel with platformvm, because a generic sequence should not be tested through one virtual machine's idea of state. What remains here covers the package on its own terms. Co-authored-by: Hanzo Dev <[email protected]>
20 lines
645 B
Go
20 lines
645 B
Go
// Copyright (C) 2019-2025, Lux Industries Inc. All rights reserved.
|
|
// See the file LICENSE for licensing terms.
|
|
|
|
package iterator
|
|
|
|
// Iterator defines an interface for iterating over a set.
|
|
type Iterator[T any] interface {
|
|
// Next attempts to move the iterator to the next element in the set. It
|
|
// returns false once there are no more elements to return.
|
|
Next() bool
|
|
|
|
// Value returns the value of the current element. Value should only be called
|
|
// after a call to Next which returned true.
|
|
Value() T
|
|
|
|
// Release any resources associated with the iterator. This must be called
|
|
// after the iterator is no longer needed.
|
|
Release()
|
|
}
|