package iterators

Import Path
	github.com/clipperhouse/uax29/v2/internal/iterators (on go.dev)

Dependency Relation
	imports 0 packages, and imported by one package

Involved Source Files

	    iterator.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Iterator[T] (struct)

		Type Parameters:
			T: Stringish

		Iterator is a generic iterator for words that are either []byte or string.
		Iterate while Next() is true, and access the word via Value().

		Methods (total 7)
			(*Iterator[T]) End() int
				End returns the byte position after the current token in the original data.

			(*Iterator[T]) Next() bool
				Next advances the iterator to the next token. It returns false when there
				are no remaining tokens or an error occurred.

			(*Iterator[T]) Reset()
				Reset resets the iterator to the beginning of the data.

			(*Iterator[T]) SetText(data T)
				SetText sets the text for the iterator to operate on, and resets all state.

			(*Iterator[T]) Split(split SplitFunc[T])
				Split sets the SplitFunc for the Iterator.

			(*Iterator[T]) Start() int
				Start returns the byte position of the current token in the original data.

			(*Iterator[T]) Value() T
				Value returns the current token.

		Implements (at least one exported)
			*Iterator : github.com/apache/arrow-go/v18/arrow/compute/exec.ArrayIter[bool]
		As Outputs Of (at least one exported)
			func New[T](split SplitFunc[T], data T) *Iterator[T]

	 type SplitFunc[T] (func)

		Type Parameters:
			T: Stringish

		As Inputs Of (at least 2)
			func New[T](split SplitFunc[T], data T) *Iterator[T]
			func (*Iterator)[T].Split(split SplitFunc[T])

	 type Stringish (interface)
Package-Level Functions (only one)

	 func New[T](split SplitFunc[T], data T) *Iterator[T]

		Type Parameters:
			T: Stringish

		New creates a new Iterator for the given data and SplitFunc.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.