| 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.Queue
Description
Contains the public fields of a Queue.
Synopsis
- newtype Queue = Queue (ManagedPtr Queue)
- newZeroQueue :: MonadIO m => m Queue
- type family ResolveQueueMethod (t :: Symbol) o where ...
- data QueueClearMethodInfo
- queueClear :: (HasCallStack, MonadIO m) => Queue -> m ()
- data QueueClearFullMethodInfo
- queueClearFull :: (HasCallStack, MonadIO m) => Queue -> Maybe DestroyNotify -> m ()
- data QueueForeachMethodInfo
- queueForeach :: (HasCallStack, MonadIO m) => Queue -> Func -> m ()
- data QueueFreeMethodInfo
- queueFree :: (HasCallStack, MonadIO m) => Queue -> m ()
- data QueueFreeFullMethodInfo
- queueFreeFull :: (HasCallStack, MonadIO m) => Queue -> DestroyNotify -> m ()
- data QueueGetLengthMethodInfo
- queueGetLength :: (HasCallStack, MonadIO m) => Queue -> m Word32
- data QueueIndexMethodInfo
- queueIndex :: (HasCallStack, MonadIO m) => Queue -> Ptr () -> m Int32
- data QueueInitMethodInfo
- queueInit :: (HasCallStack, MonadIO m) => Queue -> m ()
- data QueueInsertSortedMethodInfo
- queueInsertSorted :: (HasCallStack, MonadIO m) => Queue -> Ptr () -> CompareDataFunc -> m ()
- data QueueIsEmptyMethodInfo
- queueIsEmpty :: (HasCallStack, MonadIO m) => Queue -> m Bool
- data QueuePeekHeadMethodInfo
- queuePeekHead :: (HasCallStack, MonadIO m) => Queue -> m (Ptr ())
- data QueuePeekNthMethodInfo
- queuePeekNth :: (HasCallStack, MonadIO m) => Queue -> Word32 -> m (Ptr ())
- data QueuePeekTailMethodInfo
- queuePeekTail :: (HasCallStack, MonadIO m) => Queue -> m (Ptr ())
- data QueuePopHeadMethodInfo
- queuePopHead :: (HasCallStack, MonadIO m) => Queue -> m (Ptr ())
- data QueuePopNthMethodInfo
- queuePopNth :: (HasCallStack, MonadIO m) => Queue -> Word32 -> m (Ptr ())
- data QueuePopTailMethodInfo
- queuePopTail :: (HasCallStack, MonadIO m) => Queue -> m (Ptr ())
- data QueuePushHeadMethodInfo
- queuePushHead :: (HasCallStack, MonadIO m) => Queue -> Ptr () -> m ()
- data QueuePushNthMethodInfo
- queuePushNth :: (HasCallStack, MonadIO m) => Queue -> Ptr () -> Int32 -> m ()
- data QueuePushTailMethodInfo
- queuePushTail :: (HasCallStack, MonadIO m) => Queue -> Ptr () -> m ()
- data QueueRemoveMethodInfo
- queueRemove :: (HasCallStack, MonadIO m) => Queue -> Ptr () -> m Bool
- data QueueRemoveAllMethodInfo
- queueRemoveAll :: (HasCallStack, MonadIO m) => Queue -> Ptr () -> m Word32
- data QueueReverseMethodInfo
- queueReverse :: (HasCallStack, MonadIO m) => Queue -> m ()
- data QueueSortMethodInfo
- queueSort :: (HasCallStack, MonadIO m) => Queue -> CompareDataFunc -> m ()
- clearQueueHead :: MonadIO m => Queue -> m ()
- getQueueHead :: MonadIO m => Queue -> m [Ptr ()]
- queue_head :: AttrLabelProxy "head"
- setQueueHead :: MonadIO m => Queue -> Ptr (GList (Ptr ())) -> m ()
- getQueueLength :: MonadIO m => Queue -> m Word32
- queue_length :: AttrLabelProxy "length"
- setQueueLength :: MonadIO m => Queue -> Word32 -> m ()
- clearQueueTail :: MonadIO m => Queue -> m ()
- getQueueTail :: MonadIO m => Queue -> m [Ptr ()]
- queue_tail :: AttrLabelProxy "tail"
- setQueueTail :: MonadIO m => Queue -> Ptr (GList (Ptr ())) -> m ()
Exported types
Memory-managed wrapper type.
Constructors
| Queue (ManagedPtr Queue) |
Instances
Methods
Click to display all available methods, including inherited ones
type family ResolveQueueMethod (t :: Symbol) o where ... Source #
Equations
clear
data QueueClearMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod QueueClearMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueueClearMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => 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
| (signature ~ (Maybe DestroyNotify -> m ()), MonadIO m) => OverloadedMethod QueueClearFullMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueueClearFullMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> Maybe DestroyNotify |
|
| -> m () |
foreach
data QueueForeachMethodInfo Source #
Instances
| (signature ~ (Func -> m ()), MonadIO m) => OverloadedMethod QueueForeachMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueueForeachMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> Func |
|
| -> 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
| (signature ~ m (), MonadIO m) => OverloadedMethod QueueFreeMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueueFreeMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => 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
| (signature ~ (DestroyNotify -> m ()), MonadIO m) => OverloadedMethod QueueFreeFullMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueueFreeFullMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> DestroyNotify |
|
| -> 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
| (signature ~ m Word32, MonadIO m) => OverloadedMethod QueueGetLengthMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueueGetLengthMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> m Word32 | Returns: the number of items in |
Returns the number of items in queue.
Since: 2.4
index
data QueueIndexMethodInfo Source #
Instances
| (signature ~ (Ptr () -> m Int32), MonadIO m) => OverloadedMethod QueueIndexMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueueIndexMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> Ptr () |
|
| -> m Int32 | Returns: the position of the first element in |
Returns the position of the first element in queue which contains data.
Since: 2.4
init
data QueueInitMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod QueueInitMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueueInitMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => 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
| (signature ~ (Ptr () -> CompareDataFunc -> m ()), MonadIO m) => OverloadedMethod QueueInsertSortedMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueueInsertSortedMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> Ptr () |
|
| -> CompareDataFunc |
|
| -> m () |
Inserts data into queue using func to determine the new position.
Since: 2.4
isEmpty
data QueueIsEmptyMethodInfo Source #
Instances
| (signature ~ m Bool, MonadIO m) => OverloadedMethod QueueIsEmptyMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueueIsEmptyMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> m Bool | Returns: |
Returns True if the queue is empty.
peekHead
data QueuePeekHeadMethodInfo Source #
Instances
| (signature ~ m (Ptr ()), MonadIO m) => OverloadedMethod QueuePeekHeadMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueuePeekHeadMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> m (Ptr ()) | Returns: the data of the first element in the queue, or |
Returns the first element of the queue.
peekNth
data QueuePeekNthMethodInfo Source #
Instances
| (signature ~ (Word32 -> m (Ptr ())), MonadIO m) => OverloadedMethod QueuePeekNthMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueuePeekNthMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> Word32 |
|
| -> m (Ptr ()) | Returns: the data for the |
Returns the n'th element of queue.
Since: 2.4
peekTail
data QueuePeekTailMethodInfo Source #
Instances
| (signature ~ m (Ptr ()), MonadIO m) => OverloadedMethod QueuePeekTailMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueuePeekTailMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> m (Ptr ()) | Returns: the data of the last element in the queue, or |
Returns the last element of the queue.
popHead
data QueuePopHeadMethodInfo Source #
Instances
| (signature ~ m (Ptr ()), MonadIO m) => OverloadedMethod QueuePopHeadMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueuePopHeadMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> m (Ptr ()) | Returns: the data of the first element in the queue, or |
Removes the first element of the queue and returns its data.
popNth
data QueuePopNthMethodInfo Source #
Instances
| (signature ~ (Word32 -> m (Ptr ())), MonadIO m) => OverloadedMethod QueuePopNthMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueuePopNthMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> Word32 |
|
| -> m (Ptr ()) | Returns: the element's data, or |
Removes the n'th element of queue and returns its data.
Since: 2.4
popTail
data QueuePopTailMethodInfo Source #
Instances
| (signature ~ m (Ptr ()), MonadIO m) => OverloadedMethod QueuePopTailMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueuePopTailMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> m (Ptr ()) | Returns: the data of the last element in the queue, or |
Removes the last element of the queue and returns its data.
pushHead
data QueuePushHeadMethodInfo Source #
Instances
| (signature ~ (Ptr () -> m ()), MonadIO m) => OverloadedMethod QueuePushHeadMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueuePushHeadMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> Ptr () |
|
| -> m () |
Adds a new element at the head of the queue.
pushNth
data QueuePushNthMethodInfo Source #
Instances
| (signature ~ (Ptr () -> Int32 -> m ()), MonadIO m) => OverloadedMethod QueuePushNthMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueuePushNthMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> Ptr () |
|
| -> Int32 |
|
| -> m () |
Inserts a new element into queue at the given position.
Since: 2.4
pushTail
data QueuePushTailMethodInfo Source #
Instances
| (signature ~ (Ptr () -> m ()), MonadIO m) => OverloadedMethod QueuePushTailMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueuePushTailMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> Ptr () |
|
| -> m () |
Adds a new element at the tail of the queue.
remove
data QueueRemoveMethodInfo Source #
Instances
| (signature ~ (Ptr () -> m Bool), MonadIO m) => OverloadedMethod QueueRemoveMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueueRemoveMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> Ptr () |
|
| -> m Bool | Returns: |
Removes the first element in queue that contains data.
Since: 2.4
removeAll
data QueueRemoveAllMethodInfo Source #
Instances
| (signature ~ (Ptr () -> m Word32), MonadIO m) => OverloadedMethod QueueRemoveAllMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueueRemoveAllMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> Ptr () |
|
| -> m Word32 | Returns: the number of elements removed from |
Remove all elements whose data equals data from queue.
Since: 2.4
reverse
data QueueReverseMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod QueueReverseMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueueReverseMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> m () |
Reverses the order of the items in queue.
Since: 2.4
sort
data QueueSortMethodInfo Source #
Instances
| (signature ~ (CompareDataFunc -> m ()), MonadIO m) => OverloadedMethod QueueSortMethodInfo Queue signature Source # | |
Defined in GI.GLib.Structs.Queue Methods overloadedMethod :: Queue -> signature # | |
| OverloadedMethodInfo QueueSortMethodInfo Queue Source # | |
Defined in GI.GLib.Structs.Queue Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Queue |
|
| -> CompareDataFunc |
|
| -> 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
queue_head :: AttrLabelProxy "head" Source #
setQueueHead :: MonadIO m => Queue -> Ptr (GList (Ptr ())) -> m () Source #
Set the value of the “head” field.
When overloading is enabled, this is equivalent to
setqueue [ #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
queue_length :: AttrLabelProxy "length" Source #
setQueueLength :: MonadIO m => Queue -> Word32 -> m () Source #
Set the value of the “length” field.
When overloading is enabled, this is equivalent to
setqueue [ #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
queue_tail :: AttrLabelProxy "tail" Source #