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

GI.GLib.Structs.Queue

Description

Contains the public fields of a Queue.

Synopsis

Exported types

newtype Queue Source #

Memory-managed wrapper type.

Constructors

Queue (ManagedPtr Queue) 

Instances

Instances details
Eq Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

(==) :: Queue -> Queue -> Bool #

(/=) :: Queue -> Queue -> Bool #

BoxedPtr Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

CallocPtr Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

ManagedPtrNewtype Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

tag ~ 'AttrSet => Constructible Queue tag Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

new :: MonadIO m => (ManagedPtr Queue -> Queue) -> [AttrOp Queue tag] -> m Queue #

HasAttributeList Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

(signature ~ (Maybe DestroyNotify -> m ()), MonadIO m) => OverloadedMethod QueueClearFullMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ m (), MonadIO m) => OverloadedMethod QueueClearMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ (Func -> m ()), MonadIO m) => OverloadedMethod QueueForeachMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ (DestroyNotify -> m ()), MonadIO m) => OverloadedMethod QueueFreeFullMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ m (), MonadIO m) => OverloadedMethod QueueFreeMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ m Word32, MonadIO m) => OverloadedMethod QueueGetLengthMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ (Ptr () -> m Int32), MonadIO m) => OverloadedMethod QueueIndexMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ m (), MonadIO m) => OverloadedMethod QueueInitMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ (Ptr () -> CompareDataFunc -> m ()), MonadIO m) => OverloadedMethod QueueInsertSortedMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ m Bool, MonadIO m) => OverloadedMethod QueueIsEmptyMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ m (Ptr ()), MonadIO m) => OverloadedMethod QueuePeekHeadMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ (Word32 -> m (Ptr ())), MonadIO m) => OverloadedMethod QueuePeekNthMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ m (Ptr ()), MonadIO m) => OverloadedMethod QueuePeekTailMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ m (Ptr ()), MonadIO m) => OverloadedMethod QueuePopHeadMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ (Word32 -> m (Ptr ())), MonadIO m) => OverloadedMethod QueuePopNthMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ m (Ptr ()), MonadIO m) => OverloadedMethod QueuePopTailMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ (Ptr () -> m ()), MonadIO m) => OverloadedMethod QueuePushHeadMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ (Ptr () -> Int32 -> m ()), MonadIO m) => OverloadedMethod QueuePushNthMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ (Ptr () -> m ()), MonadIO m) => OverloadedMethod QueuePushTailMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ (Ptr () -> m Word32), MonadIO m) => OverloadedMethod QueueRemoveAllMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ (Ptr () -> m Bool), MonadIO m) => OverloadedMethod QueueRemoveMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ m (), MonadIO m) => OverloadedMethod QueueReverseMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

(signature ~ (CompareDataFunc -> m ()), MonadIO m) => OverloadedMethod QueueSortMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueClearFullMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueueClearMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueueForeachMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueueFreeFullMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueueFreeMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueueGetLengthMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueueIndexMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueueInitMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueueInsertSortedMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueueIsEmptyMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueuePeekHeadMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueuePeekNthMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueuePeekTailMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueuePopHeadMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueuePopNthMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueuePopTailMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueuePushHeadMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueuePushNthMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueuePushTailMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueueRemoveAllMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueueRemoveMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueueReverseMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

OverloadedMethodInfo QueueSortMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

(info ~ ResolveQueueMethod t Queue, OverloadedMethod info Queue p, HasField t Queue p) => HasField (t :: Symbol) Queue (p :: Type) Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

getField :: Queue -> p #

(info ~ ResolveQueueMethod t Queue, OverloadedMethodInfo info Queue) => IsLabel t (MethodProxy info Queue) Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

fromLabel :: MethodProxy info Queue #

(info ~ ResolveQueueMethod t Queue, OverloadedMethod info Queue p) => IsLabel t (Queue -> p) Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

fromLabel :: Queue -> p #

type AttributeList Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

newZeroQueue :: MonadIO m => m Queue Source #

Construct a Queue struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

clear, clearFull, foreach, free, freeFull, index, init, insertSorted, isEmpty, peekHead, peekNth, peekTail, popHead, popNth, popTail, pushHead, pushNth, pushTail, remove, removeAll, reverse, sort.

Getters

getLength.

Setters

None.

clear

data QueueClearMethodInfo Source #

Instances

Instances details
(signature ~ m (), MonadIO m) => OverloadedMethod QueueClearMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueClearMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queueClear Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> m () 

Removes all the elements in queue. If queue elements contain dynamically-allocated memory, they should be freed first.

Since: 2.14

clearFull

data QueueClearFullMethodInfo Source #

Instances

Instances details
(signature ~ (Maybe DestroyNotify -> m ()), MonadIO m) => OverloadedMethod QueueClearFullMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueClearFullMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queueClearFull Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a pointer to a Queue

-> Maybe DestroyNotify

freeFunc: the function to be called to free memory allocated

-> m () 

Convenience method, which frees all the memory used by a Queue, and calls the provided freeFunc on each item in the Queue.

Since: 2.60

foreach

data QueueForeachMethodInfo Source #

Instances

Instances details
(signature ~ (Func -> m ()), MonadIO m) => OverloadedMethod QueueForeachMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueForeachMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queueForeach Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> Func

func: the function to call for each element's data

-> m () 

Calls func for each element in the queue passing userData to the function.

It is safe for func to remove the element from queue, but it must not modify any part of the queue after that element.

Since: 2.4

free

data QueueFreeMethodInfo Source #

Instances

Instances details
(signature ~ m (), MonadIO m) => OverloadedMethod QueueFreeMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueFreeMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queueFree Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> m () 

Frees the memory allocated for the Queue. Only call this function if queue was created with g_queue_new(). If queue elements contain dynamically-allocated memory, they should be freed first.

If queue elements contain dynamically-allocated memory, you should either use queueFreeFull or free them manually first.

freeFull

data QueueFreeFullMethodInfo Source #

Instances

Instances details
(signature ~ (DestroyNotify -> m ()), MonadIO m) => OverloadedMethod QueueFreeFullMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueFreeFullMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queueFreeFull Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a pointer to a Queue

-> DestroyNotify

freeFunc: the function to be called to free each element's data

-> m () 

Convenience method, which frees all the memory used by a Queue, and calls the specified destroy function on every element's data.

freeFunc should not modify the queue (eg, by removing the freed element from it).

Since: 2.32

getLength

data QueueGetLengthMethodInfo Source #

Instances

Instances details
(signature ~ m Word32, MonadIO m) => OverloadedMethod QueueGetLengthMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueGetLengthMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queueGetLength Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> m Word32

Returns: the number of items in queue

Returns the number of items in queue.

Since: 2.4

index

data QueueIndexMethodInfo Source #

Instances

Instances details
(signature ~ (Ptr () -> m Int32), MonadIO m) => OverloadedMethod QueueIndexMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueIndexMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queueIndex Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> Ptr ()

data: the data to find

-> m Int32

Returns: the position of the first element in queue which contains data, or -1 if no element in queue contains data

Returns the position of the first element in queue which contains data.

Since: 2.4

init

data QueueInitMethodInfo Source #

Instances

Instances details
(signature ~ m (), MonadIO m) => OverloadedMethod QueueInitMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueInitMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queueInit Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: an uninitialized Queue

-> m () 

A statically-allocated Queue must be initialized with this function before it can be used. Alternatively you can initialize it with G_QUEUE_INIT. It is not necessary to initialize queues created with g_queue_new().

Since: 2.14

insertSorted

data QueueInsertSortedMethodInfo Source #

Instances

Instances details
(signature ~ (Ptr () -> CompareDataFunc -> m ()), MonadIO m) => OverloadedMethod QueueInsertSortedMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueInsertSortedMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queueInsertSorted Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> Ptr ()

data: the data to insert

-> CompareDataFunc

func: the CompareDataFunc used to compare elements in the queue. It is called with two elements of the queue and userData. It should return 0 if the elements are equal, a negative value if the first element comes before the second, and a positive value if the second element comes before the first.

-> m () 

Inserts data into queue using func to determine the new position.

Since: 2.4

isEmpty

data QueueIsEmptyMethodInfo Source #

Instances

Instances details
(signature ~ m Bool, MonadIO m) => OverloadedMethod QueueIsEmptyMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueIsEmptyMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queueIsEmpty Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue.

-> m Bool

Returns: True if the queue is empty

Returns True if the queue is empty.

peekHead

data QueuePeekHeadMethodInfo Source #

Instances

Instances details
(signature ~ m (Ptr ()), MonadIO m) => OverloadedMethod QueuePeekHeadMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueuePeekHeadMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queuePeekHead Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> m (Ptr ())

Returns: the data of the first element in the queue, or Nothing if the queue is empty

Returns the first element of the queue.

peekNth

data QueuePeekNthMethodInfo Source #

Instances

Instances details
(signature ~ (Word32 -> m (Ptr ())), MonadIO m) => OverloadedMethod QueuePeekNthMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueuePeekNthMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queuePeekNth Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> Word32

n: the position of the element

-> m (Ptr ())

Returns: the data for the n'th element of queue, or Nothing if n is off the end of queue

Returns the n'th element of queue.

Since: 2.4

peekTail

data QueuePeekTailMethodInfo Source #

Instances

Instances details
(signature ~ m (Ptr ()), MonadIO m) => OverloadedMethod QueuePeekTailMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueuePeekTailMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queuePeekTail Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> m (Ptr ())

Returns: the data of the last element in the queue, or Nothing if the queue is empty

Returns the last element of the queue.

popHead

data QueuePopHeadMethodInfo Source #

Instances

Instances details
(signature ~ m (Ptr ()), MonadIO m) => OverloadedMethod QueuePopHeadMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueuePopHeadMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queuePopHead Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> m (Ptr ())

Returns: the data of the first element in the queue, or Nothing if the queue is empty

Removes the first element of the queue and returns its data.

popNth

data QueuePopNthMethodInfo Source #

Instances

Instances details
(signature ~ (Word32 -> m (Ptr ())), MonadIO m) => OverloadedMethod QueuePopNthMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueuePopNthMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queuePopNth Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> Word32

n: the position of the element

-> m (Ptr ())

Returns: the element's data, or Nothing if n is off the end of queue

Removes the n'th element of queue and returns its data.

Since: 2.4

popTail

data QueuePopTailMethodInfo Source #

Instances

Instances details
(signature ~ m (Ptr ()), MonadIO m) => OverloadedMethod QueuePopTailMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueuePopTailMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queuePopTail Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> m (Ptr ())

Returns: the data of the last element in the queue, or Nothing if the queue is empty

Removes the last element of the queue and returns its data.

pushHead

data QueuePushHeadMethodInfo Source #

Instances

Instances details
(signature ~ (Ptr () -> m ()), MonadIO m) => OverloadedMethod QueuePushHeadMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueuePushHeadMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queuePushHead Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue.

-> Ptr ()

data: the data for the new element.

-> m () 

Adds a new element at the head of the queue.

pushNth

data QueuePushNthMethodInfo Source #

Instances

Instances details
(signature ~ (Ptr () -> Int32 -> m ()), MonadIO m) => OverloadedMethod QueuePushNthMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueuePushNthMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queuePushNth Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> Ptr ()

data: the data for the new element

-> Int32

n: the position to insert the new element. If n is negative or larger than the number of elements in the queue, the element is added to the end of the queue.

-> m () 

Inserts a new element into queue at the given position.

Since: 2.4

pushTail

data QueuePushTailMethodInfo Source #

Instances

Instances details
(signature ~ (Ptr () -> m ()), MonadIO m) => OverloadedMethod QueuePushTailMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueuePushTailMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queuePushTail Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> Ptr ()

data: the data for the new element

-> m () 

Adds a new element at the tail of the queue.

remove

data QueueRemoveMethodInfo Source #

Instances

Instances details
(signature ~ (Ptr () -> m Bool), MonadIO m) => OverloadedMethod QueueRemoveMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueRemoveMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queueRemove Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> Ptr ()

data: the data to remove

-> m Bool

Returns: True if data was found and removed from queue

Removes the first element in queue that contains data.

Since: 2.4

removeAll

data QueueRemoveAllMethodInfo Source #

Instances

Instances details
(signature ~ (Ptr () -> m Word32), MonadIO m) => OverloadedMethod QueueRemoveAllMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueRemoveAllMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queueRemoveAll Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> Ptr ()

data: the data to remove

-> m Word32

Returns: the number of elements removed from queue

Remove all elements whose data equals data from queue.

Since: 2.4

reverse

data QueueReverseMethodInfo Source #

Instances

Instances details
(signature ~ m (), MonadIO m) => OverloadedMethod QueueReverseMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueReverseMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queueReverse Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> m () 

Reverses the order of the items in queue.

Since: 2.4

sort

data QueueSortMethodInfo Source #

Instances

Instances details
(signature ~ (CompareDataFunc -> m ()), MonadIO m) => OverloadedMethod QueueSortMethodInfo Queue signature Source # 
Instance details

Defined in GI.GLib.Structs.Queue

Methods

overloadedMethod :: Queue -> signature #

OverloadedMethodInfo QueueSortMethodInfo Queue Source # 
Instance details

Defined in GI.GLib.Structs.Queue

queueSort Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Queue

queue: a Queue

-> CompareDataFunc

compareFunc: the CompareDataFunc used to sort queue. This function is passed two elements of the queue and should return 0 if they are equal, a negative value if the first comes before the second, and a positive value if the second comes before the first.

-> m () 

Sorts queue using compareFunc.

Since: 2.4

Properties

head

a pointer to the first element of the queue

clearQueueHead :: MonadIO m => Queue -> m () Source #

Set the value of the “head” field to Nothing. When overloading is enabled, this is equivalent to

clear #head

getQueueHead :: MonadIO m => Queue -> m [Ptr ()] Source #

Get the value of the “head” field. When overloading is enabled, this is equivalent to

get queue #head

setQueueHead :: MonadIO m => Queue -> Ptr (GList (Ptr ())) -> m () Source #

Set the value of the “head” field. When overloading is enabled, this is equivalent to

set queue [ #head := value ]

length

the number of elements in the queue

getQueueLength :: MonadIO m => Queue -> m Word32 Source #

Get the value of the “length” field. When overloading is enabled, this is equivalent to

get queue #length

setQueueLength :: MonadIO m => Queue -> Word32 -> m () Source #

Set the value of the “length” field. When overloading is enabled, this is equivalent to

set queue [ #length := value ]

tail

a pointer to the last element of the queue

clearQueueTail :: MonadIO m => Queue -> m () Source #

Set the value of the “tail” field to Nothing. When overloading is enabled, this is equivalent to

clear #tail

getQueueTail :: MonadIO m => Queue -> m [Ptr ()] Source #

Get the value of the “tail” field. When overloading is enabled, this is equivalent to

get queue #tail

setQueueTail :: MonadIO m => Queue -> Ptr (GList (Ptr ())) -> m () Source #

Set the value of the “tail” field. When overloading is enabled, this is equivalent to

set queue [ #tail := value ]