iterutil

Documentation

Index

• func Map(err error) error
• func StopIteration() error

Functions

func Map

func Map(err error) error

Map the nil if it is StopIteration, or keep the error otherwise

func StopIteration

func StopIteration() error

StopIteration returns a sentinel error that indicates stopping the iteration.

This error should not be propagated further, i.e., if a closure returns this error, the loop should break returning nil error. For example:

f := func(i int) error {
	if i == 10 {
		return iterutil.StopIteration()
	}
	return nil
}

for i := range slice {
	if err := f(i); err != nil {
		return iterutil.Map(err)
	}
	// continue when nil error
}