GI.GLib.Structs.SequenceIter

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

Exported types

newtype SequenceIter

Constructors

SequenceIter (ManagedPtr SequenceIter)

Instances

WrappedPtr SequenceIter

Methods

wrappedPtrCalloc :: IO (Ptr SequenceIter)

wrappedPtrCopy :: SequenceIter -> IO SequenceIter

wrappedPtrFree :: Maybe (FunPtr (Ptr SequenceIter -> IO ()))

noSequenceIter :: Maybe SequenceIter

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

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