MishkaInstaller.QueueAssistant (Mishka installer v0.1.7)

A thin FIFO queue wrapper over the Erlang :queue module.

It is used to serialise background work (event compilation, library installation) so that only one job runs at a time.

alias MishkaInstaller.QueueAssistant

{{:value, item}, queue} =
  QueueAssistant.new()
  |> QueueAssistant.insert(:job)
  |> QueueAssistant.out()

Summary

t()

An Erlang queue.

empty?(queue)

Returns true if queue is empty (or nil).

Inserts item at the rear of queue and returns the new queue.

new()

Returns a new empty queue.

out(queue)

Removes the item at the front of queue.

@type t() :: :queue.queue(any())

An Erlang queue.

@spec empty?(t() | nil) :: boolean()

Returns true if queue is empty (or nil).

@spec insert(t(), any()) :: t()

Inserts item at the rear of queue and returns the new queue.

@spec new() :: t()

Returns a new empty queue.

@spec out(t()) :: {{:value, any()}, t()} | {:empty, t()}

Removes the item at the front of queue.

Returns {{:value, item}, queue} or {:empty, queue} when the queue is empty.