collections

Documentation

Index

• Constants
• Variables
• type Queue
  • func NewQueue[T any](sb *collections.SchemaBuilder, prefix collections.Prefix, name string, ...) Queue[T]
  • func (q Queue[T]) Dequeue(ctx context.Context) (elem T, err error)
  • func (q Queue[T]) Enqueue(ctx context.Context, elem T) error
  • func (q Queue[T]) Front(ctx context.Context) (uint64, error)
  • func (q Queue[T]) Get(ctx context.Context, index uint64) (elem T, err error)
  • func (q Queue[T]) Initialize(ctx context.Context) error
  • func (q Queue[T]) IsEmpty(ctx context.Context) bool
  • func (q Queue[T]) Iterate(ctx context.Context) (collections.Iterator[uint64, T], error)
  • func (q Queue[T]) Len(ctx context.Context) uint64
  • func (q Queue[T]) Peek(ctx context.Context) (elem T, err error)
  • func (q Queue[T]) Rear(ctx context.Context) (uint64, error)

Constants

const (
	QueueElementsNameSuffix   = "_elements"
	QueueFrontNameSuffix      = "_front"
	QueueRearNameSuffix       = "_rear"
	QueueElementsPrefixSuffix = 0x0
	QueueFrontPrefixSuffix    = 0x1
	QueueRearPrefixSuffix     = 0x2
)

Variables

var (
	ErrPeek             = errors.New("queue peek failed")
	ErrEmptyQueue       = errors.New("queue is empty")
	ErrOutOfBoundsQueue = errors.New("queue index is out of bounds")
)

Types

type Queue

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

func NewQueue

func NewQueue[T any](sb *collections.SchemaBuilder, prefix collections.Prefix, name string, vc codec.ValueCodec[T]) Queue[T]

func (Queue[T]) Dequeue

func (q Queue[T]) Dequeue(ctx context.Context) (elem T, err error)

func (Queue[T]) Enqueue

func (q Queue[T]) Enqueue(ctx context.Context, elem T) error

func (Queue[T]) Front

func (q Queue[T]) Front(ctx context.Context) (uint64, error)

func (Queue[T]) Get

func (q Queue[T]) Get(ctx context.Context, index uint64) (elem T, err error)

func (Queue[T]) Initialize

func (q Queue[T]) Initialize(ctx context.Context) error

func (Queue[T]) IsEmpty

func (q Queue[T]) IsEmpty(ctx context.Context) bool

func (Queue[T]) Iterate

func (q Queue[T]) Iterate(ctx context.Context) (collections.Iterator[uint64, T], error)

TODO: Iterate with a custom range, clamp the range to the front and rear.

func (Queue[T]) Len

func (q Queue[T]) Len(ctx context.Context) uint64

func (Queue[T]) Peek

func (q Queue[T]) Peek(ctx context.Context) (elem T, err error)

func (Queue[T]) Rear

func (q Queue[T]) Rear(ctx context.Context) (uint64, error)