iterator

Documentation

Index

• func IsIterator(item stackitem.Item) bool
• func Next(ic *interop.Context) error
• func Value(ic *interop.Context) error
• func Values(item stackitem.Item, max int) []stackitem.Item
• func ValuesTruncated(item stackitem.Item, max int) ([]stackitem.Item, bool)

Functions

func IsIterator

func IsIterator(item stackitem.Item) bool

IsIterator returns whether stackitem implements iterator interface.

func Next

func Next(ic *interop.Context) error

Next advances the iterator, pushes true on success and false otherwise.

func Value

func Value(ic *interop.Context) error

Value returns current iterator value and depends on iterator type: For slices the result is just value. For maps the result is key-value pair packed in a struct.

func Values

func Values(item stackitem.Item, max int) []stackitem.Item

Values returns an array of up to `max` iterator values. The provided iterator can safely be reused to retrieve the rest of its values in the subsequent calls to Values and to ValuesTruncated.

func ValuesTruncated

func ValuesTruncated(item stackitem.Item, max int) ([]stackitem.Item, bool)

ValuesTruncated returns an array of up to `max` iterator values. The second return parameter denotes whether iterator is truncated, i.e. has more values. The provided iterator CAN NOT be reused in the subsequent calls to Values and to ValuesTruncated.