mem

Documentation

Overview

package mem provides an in-memory implementation of a queue data structure.

Index

• type Queue
  • func NewQueue[T types.Marshallable]() *Queue[T]
  • func (q *Queue[T]) Delete(string) error
  • func (q *Queue[T]) Len() int
  • func (q *Queue[T]) Push(val T) (string, error)
  • func (q *Queue[T]) Receive() (string, T, bool)
  • func (q *Queue[T]) ReceiveMany(num int32) ([]string, []T, error)

Types

type Queue

type Queue[T types.Marshallable] struct {
	// contains filtered or unexported fields
}

Queue is a thread-safe FIFO queue implementation.

func NewQueue

func NewQueue[T types.Marshallable]() *Queue[T]

NewQueue creates a new Queue instance.

func (*Queue[T]) Delete

func (q *Queue[T]) Delete(string) error

Delete is no-op for the in-memory queue (already deleted by receiving).

func (*Queue[T]) Len

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

Len returns the number of elements currently in the queue.

func (*Queue[T]) Push

func (q *Queue[T]) Push(val T) (string, error)

Push adds a value to the back of the queue.

func (*Queue[T]) Receive

func (q *Queue[T]) Receive() (string, T, bool)

Pop returns the value at the front of the queue without removing it. The second return value indicates if the operation succeeded.

func (*Queue[T]) ReceiveMany

func (q *Queue[T]) ReceiveMany(num int32) ([]string, []T, error)