gi-glib-2.0.23: GLib bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.GLib.Structs.SequenceIter

Contents

Description

The tSequenceIter struct is an opaque data type representing an iterator pointing into a tSequence.

Synopsis

Exported types

newtype SequenceIter Source #

Memory-managed wrapper type.

Constructors

SequenceIter (ManagedPtr SequenceIter) 
Instances
Eq SequenceIter Source # 
Instance details

Defined in GI.GLib.Structs.SequenceIter

Methods

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

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

WrappedPtr SequenceIter Source # 
Instance details

Defined in GI.GLib.Structs.SequenceIter

noSequenceIter :: Maybe SequenceIter Source #

A convenience alias for Nothing :: Maybe SequenceIter.

Methods

Overloaded methods

compare

sequenceIterCompare Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> SequenceIter

a: a tSequenceIter

-> SequenceIter

b: a tSequenceIter

-> 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 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> SequenceIter

iter: a tSequenceIter

-> m Int32

Returns: the position of iter

Returns the position of iter

Since: 2.14

getSequence

sequenceIterGetSequence Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> SequenceIter

iter: a tSequenceIter

-> m Sequence

Returns: the tSequence that iter points into

Returns the tSequence that iter points into.

Since: 2.14

isBegin

sequenceIterIsBegin Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> SequenceIter

iter: a tSequenceIter

-> m Bool

Returns: whether iter is the begin iterator

Returns whether iter is the begin iterator

Since: 2.14

isEnd

sequenceIterIsEnd Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> SequenceIter

iter: a tSequenceIter

-> m Bool

Returns: Whether iter is the end iterator

Returns whether iter is the end iterator

Since: 2.14

move

sequenceIterMove Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> SequenceIter

iter: a tSequenceIter

-> Int32

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

-> m SequenceIter

Returns: a tSequenceIter which is delta positions away from iter

Returns the tSequenceIter 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 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> SequenceIter

iter: a tSequenceIter

-> m SequenceIter

Returns: a tSequenceIter 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 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> SequenceIter

iter: a tSequenceIter

-> m SequenceIter

Returns: a tSequenceIter 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