queue

Documentation

Overview

Package queue implements a FIFO queue generic over any type.

The queue is not safe for concurrent access across goroutines, the caller is responsible for synchronising concurrent access.

Index

• type Queue
  • func Collect[T any](items iter.Seq[T]) *Queue[T]
  • func From[T any](items []T) *Queue[T]
  • func New[T any]() *Queue[T]
  • func (q *Queue[T]) Empty() bool
  • func (q *Queue[T]) Items() iter.Seq[T]
  • func (q *Queue[T]) Pop() (T, error)
  • func (q *Queue[T]) Push(item T)
  • func (q *Queue[T]) Size() int
  • func (q *Queue[T]) String() string

Types

type Queue

type Queue[T any] struct {
	// contains filtered or unexported fields
}

Queue is a FIFO queue generic over any type.

A Queue should be instantiated by the New function and not directly.

func Collect

func Collect[T any](items iter.Seq[T]) *Queue[T]

Collect builds a Queue from an iterator of items, pushing items into the queue in the order of iteration.

func From

func From[T any](items []T) *Queue[T]

From builds a Queue from an existing slice of items, pushing items into the queue in the order of the slice.

The queue will be preallocated the size of len(items).

func New

func New[T any]() *Queue[T]

New constructs and returns a new Queue.

func (*Queue[T]) Empty

func (q *Queue[T]) Empty() bool

Empty returns whether or not the queue is empty.

s := queue.New[string]()
s.Empty() // true
s.Push("hello")
s.Empty() // false

func (*Queue[T]) Items

func (q *Queue[T]) Items() iter.Seq[T]

Items returns the an iterator over the queue in FIFO order.

q := queue.New[string]()
q.Push("hello")
q.Push("there")
qlices.Collect(s.Items()) // [hello there]

func (*Queue[T]) Pop

func (q *Queue[T]) Pop() (T, error)

Pop removes an item from the front of the queue, if the queue is empty, an error will be returned.

q := queue.New[string]()
q.Push("hello")
q.Push("there")
item, _ := q.Pop()
fmt.Println(item) // "hello"

func (*Queue[T]) Push

func (q *Queue[T]) Push(item T)

Push adds an item to the back of the queue.

q := queue.New[string]()
q.Push("hello")

func (*Queue[T]) Size

func (q *Queue[T]) Size() int

Size returns the number of items in the queue.

s := queue.New[string]()
s.Size() // 0
s.Push("hello")
s.Push("there")
s.Size() // 2

func (*Queue[T]) String

func (q *Queue[T]) String() string

String satisfies the fmt.Stringer interface and allows a Queue to be printed.