GI.GLib.Structs.Queue

Contains the public fields of a [Queue][glib-Double-ended-Queues].

Exported types

newtype Queue

Memory-managed wrapper type.

Constructors

Queue (ManagedPtr Queue)

Instances

WrappedPtr Queue

Defined in GI.GLib.Structs.Queue

Methods

wrappedPtrCalloc :: IO (Ptr Queue)

wrappedPtrCopy :: Queue -> IO Queue

wrappedPtrFree :: Maybe (GDestroyNotify Queue)

tag ~ AttrSet => Constructible Queue tag

Defined in GI.GLib.Structs.Queue

Methods

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

newZeroQueue :: MonadIO m => m Queue

Construct a Queue struct initialized to zero.

noQueue :: Maybe Queue

A convenience alias for Nothing :: Maybe Queue.

Methods

clear

queueClear

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

queueClearFull

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

free

queueFree

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

queueFreeFull

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

queueGetLength

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

queueIndex

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

queueInit

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

isEmpty

queueIsEmpty

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

queuePeekHead

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

queuePeekNth

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

queuePeekTail

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

queuePopHead

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

queuePopNth

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

queuePopTail

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

queuePushHead

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

queuePushNth

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

queuePushTail

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

queueRemove

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

queueRemoveAll

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

queueReverse

Arguments

:: (HasCallStack, MonadIO m)

=> Queue

queue: a Queue

-> m ()

Reverses the order of the items in queue.

Since: 2.4

Properties

head

a pointer to the first element of the queue

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

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 ()]

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 ()

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

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

get queue #length

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

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 ()

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 ()]

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 ()

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

set queue [ #tail := value ]