Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
GI.GLib.Structs.SequenceIter
Description
The SequenceIter
struct is an opaque data type representing an
iterator pointing into a Sequence
.
- newtype SequenceIter = SequenceIter (ManagedPtr SequenceIter)
- noSequenceIter :: Maybe SequenceIter
- data SequenceIterCompareMethodInfo
- sequenceIterCompare :: (HasCallStack, MonadIO m) => SequenceIter -> SequenceIter -> m Int32
- data SequenceIterGetPositionMethodInfo
- sequenceIterGetPosition :: (HasCallStack, MonadIO m) => SequenceIter -> m Int32
- data SequenceIterGetSequenceMethodInfo
- sequenceIterGetSequence :: (HasCallStack, MonadIO m) => SequenceIter -> m Sequence
- data SequenceIterIsBeginMethodInfo
- sequenceIterIsBegin :: (HasCallStack, MonadIO m) => SequenceIter -> m Bool
- data SequenceIterIsEndMethodInfo
- sequenceIterIsEnd :: (HasCallStack, MonadIO m) => SequenceIter -> m Bool
- data SequenceIterMoveMethodInfo
- sequenceIterMove :: (HasCallStack, MonadIO m) => SequenceIter -> Int32 -> m SequenceIter
- data SequenceIterNextMethodInfo
- sequenceIterNext :: (HasCallStack, MonadIO m) => SequenceIter -> m SequenceIter
- data SequenceIterPrevMethodInfo
- sequenceIterPrev :: (HasCallStack, MonadIO m) => SequenceIter -> m SequenceIter
Exported types
newtype SequenceIter #
Constructors
SequenceIter (ManagedPtr SequenceIter) |
Instances
Methods
compare
data SequenceIterCompareMethodInfo #
Instances
((~) * signature (SequenceIter -> m Int32), MonadIO m) => MethodInfo * SequenceIterCompareMethodInfo SequenceIter signature # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> SequenceIter |
|
-> SequenceIter |
|
-> m Int32 | Returns: a negative number if |
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
data SequenceIterGetPositionMethodInfo #
Instances
((~) * signature (m Int32), MonadIO m) => MethodInfo * SequenceIterGetPositionMethodInfo SequenceIter signature # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> SequenceIter |
|
-> m Int32 | Returns: the position of |
Returns the position of iter
Since: 2.14
getSequence
data SequenceIterGetSequenceMethodInfo #
Instances
((~) * signature (m Sequence), MonadIO m) => MethodInfo * SequenceIterGetSequenceMethodInfo SequenceIter signature # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> SequenceIter |
|
-> m Sequence | Returns: the |
Returns the Sequence
that iter
points into.
Since: 2.14
isBegin
data SequenceIterIsBeginMethodInfo #
Instances
((~) * signature (m Bool), MonadIO m) => MethodInfo * SequenceIterIsBeginMethodInfo SequenceIter signature # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> SequenceIter |
|
-> m Bool | Returns: whether |
Returns whether iter
is the begin iterator
Since: 2.14
isEnd
data SequenceIterIsEndMethodInfo #
Instances
((~) * signature (m Bool), MonadIO m) => MethodInfo * SequenceIterIsEndMethodInfo SequenceIter signature # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> SequenceIter |
|
-> m Bool | Returns: Whether |
Returns whether iter
is the end iterator
Since: 2.14
move
data SequenceIterMoveMethodInfo #
Instances
((~) * signature (Int32 -> m SequenceIter), MonadIO m) => MethodInfo * SequenceIterMoveMethodInfo SequenceIter signature # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> SequenceIter |
|
-> Int32 |
|
-> m SequenceIter | Returns: a |
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
data SequenceIterNextMethodInfo #
Instances
((~) * signature (m SequenceIter), MonadIO m) => MethodInfo * SequenceIterNextMethodInfo SequenceIter signature # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> SequenceIter |
|
-> m SequenceIter | Returns: a |
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
data SequenceIterPrevMethodInfo #
Instances
((~) * signature (m SequenceIter), MonadIO m) => MethodInfo * SequenceIterPrevMethodInfo SequenceIter signature # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> SequenceIter |
|
-> m SequenceIter | Returns: a |
Returns an iterator pointing to the previous position before iter
.
If iter
is the begin iterator, the begin iterator is returned.
Since: 2.14