SequenceIter

class SequenceIter(*args, **kwargs)

The SequenceIter struct is an opaque data type representing an iterator pointing into a Sequence.

Methods

class SequenceIter

compare(b: SequenceIter) → int

Returns a negative number if a comes before b, 0 if they are equal, and a positive number if a comes after b.

The a and b iterators must point into the same sequence.

Added in version 2.14.

Parameters:

b – a SequenceIter

get_position() → int

Returns the position of iter

Added in version 2.14.

get_sequence() → Sequence

Returns the Sequence that iter points into.

Added in version 2.14.

is_begin() → bool

Returns whether iter is the begin iterator

Added in version 2.14.

is_end() → bool

Returns whether iter is the end iterator

Added in version 2.14.

move(delta: int) → SequenceIter

Returns the SequenceIter which is delta positions away from iter. If iter is closer than -delta positions to the beginning of the sequence, the begin iterator is returned. If iter is closer than delta positions to the end of the sequence, the end iterator is returned.

Added in version 2.14.

Parameters:

delta – A positive or negative number indicating how many positions away from iter the returned SequenceIter will be

next() → SequenceIter

Returns an iterator pointing to the next position after iter. If iter is the end iterator, the end iterator is returned.

Added in version 2.14.

prev() → SequenceIter

Returns an iterator pointing to the previous position before iter. If iter is the begin iterator, the begin iterator is returned.

Added in version 2.14.