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

Contents

Exported types
Methods

Description

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

Synopsis

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 ())) #
((~) * info (ResolveSequenceIterMethod t SequenceIter), MethodInfo * info SequenceIter p) => IsLabel t (SequenceIter -> p) #
Methods fromLabel :: Proxy# Symbol t -> SequenceIter -> p #
((~) * info (ResolveSequenceIterMethod t SequenceIter), MethodInfo * info SequenceIter p) => IsLabelProxy t (SequenceIter -> p) #
Methods fromLabelProxy :: Proxy Symbol t -> SequenceIter -> p #
HasAttributeList * SequenceIter #

((~) * signature (m SequenceIter), MonadIO m) => MethodInfo * SequenceIterPrevMethodInfo SequenceIter signature #
Methods overloadedMethod :: MethodProxy SequenceIterPrevMethodInfo SequenceIter -> signature -> s #
((~) * signature (m SequenceIter), MonadIO m) => MethodInfo * SequenceIterNextMethodInfo SequenceIter signature #
Methods overloadedMethod :: MethodProxy SequenceIterNextMethodInfo SequenceIter -> signature -> s #
((~) * signature (Int32 -> m SequenceIter), MonadIO m) => MethodInfo * SequenceIterMoveMethodInfo SequenceIter signature #
Methods overloadedMethod :: MethodProxy SequenceIterMoveMethodInfo SequenceIter -> signature -> s #
((~) * signature (m Bool), MonadIO m) => MethodInfo * SequenceIterIsEndMethodInfo SequenceIter signature #
Methods overloadedMethod :: MethodProxy SequenceIterIsEndMethodInfo SequenceIter -> signature -> s #
((~) * signature (m Bool), MonadIO m) => MethodInfo * SequenceIterIsBeginMethodInfo SequenceIter signature #
Methods overloadedMethod :: MethodProxy SequenceIterIsBeginMethodInfo SequenceIter -> signature -> s #
((~) * signature (m Sequence), MonadIO m) => MethodInfo * SequenceIterGetSequenceMethodInfo SequenceIter signature #
Methods overloadedMethod :: MethodProxy SequenceIterGetSequenceMethodInfo SequenceIter -> signature -> s #
((~) * signature (m Int32), MonadIO m) => MethodInfo * SequenceIterGetPositionMethodInfo SequenceIter signature #
Methods overloadedMethod :: MethodProxy SequenceIterGetPositionMethodInfo SequenceIter -> signature -> s #
((~) * signature (SequenceIter -> m Int32), MonadIO m) => MethodInfo * SequenceIterCompareMethodInfo SequenceIter signature #
Methods overloadedMethod :: MethodProxy SequenceIterCompareMethodInfo SequenceIter -> signature -> s #
type AttributeList SequenceIter #
type AttributeList SequenceIter

noSequenceIter :: Maybe SequenceIter #

Methods

compare

data SequenceIterCompareMethodInfo #

Instances

((~) * signature (SequenceIter -> m Int32), MonadIO m) => MethodInfo * SequenceIterCompareMethodInfo SequenceIter signature #
Methods overloadedMethod :: MethodProxy SequenceIterCompareMethodInfo SequenceIter -> signature -> s #

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

data SequenceIterGetPositionMethodInfo #

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * SequenceIterGetPositionMethodInfo SequenceIter signature #
Methods overloadedMethod :: MethodProxy SequenceIterGetPositionMethodInfo SequenceIter -> signature -> s #

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

data SequenceIterGetSequenceMethodInfo #

Instances

((~) * signature (m Sequence), MonadIO m) => MethodInfo * SequenceIterGetSequenceMethodInfo SequenceIter signature #
Methods overloadedMethod :: MethodProxy SequenceIterGetSequenceMethodInfo SequenceIter -> signature -> s #

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

data SequenceIterIsBeginMethodInfo #

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * SequenceIterIsBeginMethodInfo SequenceIter signature #
Methods overloadedMethod :: MethodProxy SequenceIterIsBeginMethodInfo SequenceIter -> signature -> s #

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

data SequenceIterIsEndMethodInfo #

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * SequenceIterIsEndMethodInfo SequenceIter signature #
Methods overloadedMethod :: MethodProxy SequenceIterIsEndMethodInfo SequenceIter -> signature -> s #

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

data SequenceIterMoveMethodInfo #

Instances

((~) * signature (Int32 -> m SequenceIter), MonadIO m) => MethodInfo * SequenceIterMoveMethodInfo SequenceIter signature #
Methods overloadedMethod :: MethodProxy SequenceIterMoveMethodInfo SequenceIter -> signature -> s #

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

Exported types

Methods

compare

getPosition

getSequence

isBegin

isEnd

move

next

prev