queue

Documentation

Index

• type Queue
  • func New[T any](capacity int) *Queue[T]
  • func (queue *Queue[T]) Capacity() int
  • func (queue *Queue[T]) ForceOffer(element T) (removedElement T, wasRemoved bool)
  • func (queue *Queue[T]) Offer(element T) bool
  • func (queue *Queue[T]) Poll() (element T, success bool)
  • func (queue *Queue[T]) Size() int

Types

type Queue

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

Queue represents a ring buffer.

func New

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

New creates a new queue with the specified capacity.

func (*Queue[T]) Capacity

func (queue *Queue[T]) Capacity() int

Capacity returns the capacity of the queue.

func (*Queue[T]) ForceOffer

func (queue *Queue[T]) ForceOffer(element T) (removedElement T, wasRemoved bool)

func (*Queue[T]) Offer

func (queue *Queue[T]) Offer(element T) bool

Offer adds an element to the queue and returns true. If the queue is full, it drops it and returns false.

func (*Queue[T]) Poll

func (queue *Queue[T]) Poll() (element T, success bool)

Poll returns and removes the oldest element in the queue and true if successful. If returns false if the queue is empty.

func (*Queue[T]) Size

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

Size returns the size of the queue.