Queue

class guppylang.std.collections.Queue

A first-in-first-out (FIFO) growable collection of values.

To ensure static allocation, the maximum queue size must be specified in advance and is tracked in the type. For example, the Queue[int, 10] is a queue that can hold at most 10 integers.

Use empty_queue to construct a new queue.

__iter__() → Queue[T, MAX_SIZE]

Returns an iterator over the elements in the queue from bottom to top.

__len__() → int

Returns the number of elements currently stored in the queue.

__next__() → Option[tuple[T, Queue[T, MAX_SIZE]]]

buf: array[Option[T], MAX_SIZE]

Underlying buffer holding the queue elements.

INVARIANT: All array elements up to and including index self.end - 1 are option.some variants and all further ones are option.nothing.

discard_empty() → None

Discards a queue of potentially non-droppable elements assuming that the queue is empty.

Panics if the queue is not empty.

end: int

Index of the next free index in self.buf.

peek() → tuple[TCopyable, Queue[TCopyable, MAX_SIZE]]

Returns a copy of the top element of the queue without removing it.

Panics if the queue is empty.

Note that this operation is only allowed if the queue elements are copyable.

pop() → tuple[T, Queue[T, MAX_SIZE]]

Removes the next element from the queue and returns it.

Panics if the queue is empty.

push(elem: T @ owned) → Queue[T, MAX_SIZE]

Adds an element to the end of the queue.

Panics if the queue has already reached its maximum size.