Queue

Deprecated: This module will be renamed to ImmutableQueue in the v0.6.0 release of Grain.

An immutable queue implementation. A queue is a FIFO (first-in-first-out) data structure where new values are added to the end and retrieved or removed from the beginning.

1

import Queue from "queue"

Types

Type declarations included in the Queue module.

Queue.Queue

1

type Queue<a>

Values

Functions and constants for working with queues.

Queue.empty

1

empty : Queue<a>

An empty queue.

Queue.make

Deprecated: This will be removed in the v0.6.0 release of Grain.

1

make : () -> Queue<a>

Creates an empty queue.

Returns:

Queue.isEmpty

1

isEmpty : Queue<a> -> Bool

Checks if the given queue contains any values.

Parameters:

Returns:

Queue.peek

1

peek : Queue<a> -> Option<a>

Returns the value at the beginning of the queue. It is not removed from the queue.

Parameters:

Returns:

Queue.push

1

push : (a, Queue<a>) -> Queue<a>

Adds a value to the end of the queue.

Parameters:

Returns:

Queue.pop

1

pop : Queue<a> -> Queue<a>

Dequeues the next value in the queue.

Parameters:

Returns:

Queue.size

1

size : Queue<a> -> Number

Get the number of values in a queue.

Parameters:

Returns: