queue_peek

Gets the item that was first added to the queue without removing it.

Syntax

value_type queue_peek(Queue* queue);

Returns: The item that was first added to the queue.

Remarks

Count checking is done via assert, so if it’s needed in a production environment, it will need to be handled by the caller. The behaviour is otherwise undefined if you try and get an item from an empty queue.

Example

QUEUE_DEFINE_H(StringQueue, str_queue, int)
QUEUE_DEFINE_C(StringQueue, str_queue, int)

StringQueue* queue = str_queue_create();

str_queue_enqueue(queue, "hello");

char* value = str_queue_peek(queue);

assert(strcmp(value, "hello") == 0);
assert(str_queue_count(queue) == 1);