Parsley.Internal.Common.QueueLike

Exposes the core shared operations of queue implementations.

Since: 1.5.0.0

Documentation

class QueueLike q where

Operations on a queue-like structure q. These operations should be efficient, with amortized constant complexity for all of them except enqueueAll.

Since: 1.5.0.0

Methods

empty :: q a

Construct an empty queue.

Since: 1.5.0.0

null :: q a -> Bool

Is the queue empty?

Since: 1.5.0.0

size :: q a -> Int

Returns how many elements are in the queue.

Since: 1.5.0.0

enqueue :: a -> q a -> q a

Adds an element onto the end of the queue.

Since: 1.5.0.0

dequeue :: q a -> (a, q a)

Removes an element from the front of the queue.

Since: 1.5.0.0

poke :: (a -> a) -> q a -> (a, q a)

modifies the head of the queue, without removal. Returns the old head

Since: 2.1.0.0

enqueueAll :: [a] -> q a -> q a

Adds each of the elements onto the queue, from left-to-right.

Since: 1.5.0.0

Instances

QueueLike Queue

Defined in Parsley.Internal.Common.Queue

Methods

empty :: Queue a

null :: Queue a -> Bool

size :: Queue a -> Int

enqueue :: a -> Queue a -> Queue a

dequeue :: Queue a -> (a, Queue a)

poke :: (a -> a) -> Queue a -> (a, Queue a)

enqueueAll :: [a] -> Queue a -> Queue a

QueueLike RewindQueue

Defined in Parsley.Internal.Common.RewindQueue

Methods

empty :: RewindQueue a

null :: RewindQueue a -> Bool

size :: RewindQueue a -> Int

enqueue :: a -> RewindQueue a -> RewindQueue a

dequeue :: RewindQueue a -> (a, RewindQueue a)

poke :: (a -> a) -> RewindQueue a -> (a, RewindQueue a)

enqueueAll :: [a] -> RewindQueue a -> RewindQueue a