iterator

Documentation

Overview

Package iterator provides functions to work with Neo iterators.

Index

• func Next(it Iterator) bool
• func Value(it Iterator) interface{}
• type Iterator

Functions

func Next

func Next(it Iterator) bool

Next advances the iterator returning true if it is was successful (and you can use Key or Value) and false otherwise (and there are no more elements in this Iterator). This function uses `System.Iterator.Next` syscall.

func Value

func Value(it Iterator) interface{}

Value returns iterator's current value. It's only valid to call after successful Next call. This function uses `System.Iterator.Value` syscall. For slices the result is just value. For maps the result can be casted to a slice of 2 elements: key and value. For storage iterators refer to `storage.FindFlags` documentation.

Types

type Iterator

type Iterator struct{}

Iterator represents a Neo iterator, it's an opaque data structure that can be properly created by Create or storage.Find. Unlike enumerators, iterators range over key-value pairs, so it's convenient to use them for maps. This structure is similar in function to Neo .net framework's Iterator.