| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| 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.
Synopsis
- newtype SequenceIter = SequenceIter (ManagedPtr SequenceIter)
- type family ResolveSequenceIterMethod (t :: Symbol) o where ...
- 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 Source #
Memory-managed wrapper type.
Constructors
| SequenceIter (ManagedPtr SequenceIter) |
Instances
Methods
Click to display all available methods, including inherited ones
type family ResolveSequenceIterMethod (t :: Symbol) o where ... Source #
Equations
| ResolveSequenceIterMethod "compare" o = SequenceIterCompareMethodInfo | |
| ResolveSequenceIterMethod "isBegin" o = SequenceIterIsBeginMethodInfo | |
| ResolveSequenceIterMethod "isEnd" o = SequenceIterIsEndMethodInfo | |
| ResolveSequenceIterMethod "move" o = SequenceIterMoveMethodInfo | |
| ResolveSequenceIterMethod "next" o = SequenceIterNextMethodInfo | |
| ResolveSequenceIterMethod "prev" o = SequenceIterPrevMethodInfo | |
| ResolveSequenceIterMethod "getPosition" o = SequenceIterGetPositionMethodInfo | |
| ResolveSequenceIterMethod "getSequence" o = SequenceIterGetSequenceMethodInfo | |
| ResolveSequenceIterMethod l o = MethodResolutionFailed l o :: Type |
compare
data SequenceIterCompareMethodInfo Source #
Instances
| (signature ~ (SequenceIter -> m Int32), MonadIO m) => OverloadedMethod SequenceIterCompareMethodInfo SequenceIter signature Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods overloadedMethod :: SequenceIter -> signature # | |
| OverloadedMethodInfo SequenceIterCompareMethodInfo SequenceIter Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods | |
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 Source #
Instances
| (signature ~ m Int32, MonadIO m) => OverloadedMethod SequenceIterGetPositionMethodInfo SequenceIter signature Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods overloadedMethod :: SequenceIter -> signature # | |
| OverloadedMethodInfo SequenceIterGetPositionMethodInfo SequenceIter Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods | |
sequenceIterGetPosition Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => SequenceIter |
|
| -> m Int32 | Returns: the position of |
Returns the position of iter
Since: 2.14
getSequence
data SequenceIterGetSequenceMethodInfo Source #
Instances
| (signature ~ m Sequence, MonadIO m) => OverloadedMethod SequenceIterGetSequenceMethodInfo SequenceIter signature Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods overloadedMethod :: SequenceIter -> signature # | |
| OverloadedMethodInfo SequenceIterGetSequenceMethodInfo SequenceIter Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods | |
sequenceIterGetSequence Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => SequenceIter |
|
| -> m Sequence | Returns: the |
Returns the Sequence that iter points into.
Since: 2.14
isBegin
data SequenceIterIsBeginMethodInfo Source #
Instances
| (signature ~ m Bool, MonadIO m) => OverloadedMethod SequenceIterIsBeginMethodInfo SequenceIter signature Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods overloadedMethod :: SequenceIter -> signature # | |
| OverloadedMethodInfo SequenceIterIsBeginMethodInfo SequenceIter Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => SequenceIter |
|
| -> m Bool | Returns: whether |
Returns whether iter is the begin iterator
Since: 2.14
isEnd
data SequenceIterIsEndMethodInfo Source #
Instances
| (signature ~ m Bool, MonadIO m) => OverloadedMethod SequenceIterIsEndMethodInfo SequenceIter signature Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods overloadedMethod :: SequenceIter -> signature # | |
| OverloadedMethodInfo SequenceIterIsEndMethodInfo SequenceIter Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => SequenceIter |
|
| -> m Bool | Returns: Whether |
Returns whether iter is the end iterator
Since: 2.14
move
data SequenceIterMoveMethodInfo Source #
Instances
| (signature ~ (Int32 -> m SequenceIter), MonadIO m) => OverloadedMethod SequenceIterMoveMethodInfo SequenceIter signature Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods overloadedMethod :: SequenceIter -> signature # | |
| OverloadedMethodInfo SequenceIterMoveMethodInfo SequenceIter Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods | |
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 Source #
Instances
| (signature ~ m SequenceIter, MonadIO m) => OverloadedMethod SequenceIterNextMethodInfo SequenceIter signature Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods overloadedMethod :: SequenceIter -> signature # | |
| OverloadedMethodInfo SequenceIterNextMethodInfo SequenceIter Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods | |
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 Source #
Instances
| (signature ~ m SequenceIter, MonadIO m) => OverloadedMethod SequenceIterPrevMethodInfo SequenceIter signature Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods overloadedMethod :: SequenceIter -> signature # | |
| OverloadedMethodInfo SequenceIterPrevMethodInfo SequenceIter Source # | |
Defined in GI.GLib.Structs.SequenceIter Methods | |
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