GI.GLib.Structs.SequenceIter

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

Exported types

newtype SequenceIter

Memory-managed wrapper type.

Constructors

SequenceIter (ManagedPtr SequenceIter)

Instances

Eq SequenceIter

Defined in GI.GLib.Structs.SequenceIter

Methods

(==) :: SequenceIter -> SequenceIter -> Bool

(/=) :: SequenceIter -> SequenceIter -> Bool

WrappedPtr SequenceIter

Defined in GI.GLib.Structs.SequenceIter

Methods

wrappedPtrCalloc :: IO (Ptr SequenceIter)

wrappedPtrCopy :: SequenceIter -> IO SequenceIter

wrappedPtrFree :: Maybe (GDestroyNotify SequenceIter)

noSequenceIter :: Maybe SequenceIter

A convenience alias for Nothing :: Maybe SequenceIter.

Methods

Overloaded methods

compare

sequenceIterCompare

Arguments

:: (HasCallStack, MonadIO m)

=> SequenceIter

a: a SequenceIter

-> SequenceIter

b: a SequenceIter

-> m Int32

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

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.

Since: 2.14

getPosition

sequenceIterGetPosition

Arguments

:: (HasCallStack, MonadIO m)

=> SequenceIter

iter: a SequenceIter

-> m Int32

Returns: the position of iter

Returns the position of iter

Since: 2.14

getSequence

sequenceIterGetSequence

Arguments

:: (HasCallStack, MonadIO m)

=> SequenceIter

iter: a SequenceIter

-> m Sequence

Returns: the Sequence that iter points into

Returns the Sequence that iter points into.

Since: 2.14

isBegin

sequenceIterIsBegin

Arguments

:: (HasCallStack, MonadIO m)

=> SequenceIter

iter: a SequenceIter

-> m Bool

Returns: whether iter is the begin iterator

Returns whether iter is the begin iterator

Since: 2.14

isEnd

sequenceIterIsEnd

Arguments

:: (HasCallStack, MonadIO m)

=> SequenceIter

iter: a SequenceIter

-> m Bool

Returns: Whether iter is the end iterator

Returns whether iter is the end iterator

Since: 2.14

move

sequenceIterMove

Arguments

:: (HasCallStack, MonadIO m)

=> SequenceIter

iter: a SequenceIter

-> Int32

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

-> m SequenceIter

Returns: a SequenceIter which is delta positions away from iter

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.

Since: 2.14

next

sequenceIterNext

Arguments

:: (HasCallStack, MonadIO m)

=> SequenceIter

iter: a SequenceIter

-> m SequenceIter

Returns: a SequenceIter pointing to the next position after iter

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

Since: 2.14

prev

sequenceIterPrev

Arguments

:: (HasCallStack, MonadIO m)

=> SequenceIter

iter: a SequenceIter

-> m SequenceIter

Returns: a SequenceIter pointing to the previous position before iter

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

Since: 2.14