stack

Documentation

Index

• type Stack
  • func New[T any](threadSafe ...bool) Stack[T]

Types

type Stack

type Stack[T any] interface {
	// Push pushes an element onto the top of this Stack.
	Push(element T)

	// Pop removes and returns the top element of this Stack and whether the element exists.
	Pop() (T, bool)

	// Peek returns the top element of this Stack without removing it.
	Peek() (T, bool)

	// Clear removes all elements from this Stack.
	Clear()

	// Size returns the amount of elements in this Stack.
	Size() int

	// IsEmpty checks if this Stack is empty.
	IsEmpty() bool
}

Stack is a stack of elements.

func New

func New[T any](threadSafe ...bool) Stack[T]

New returns a new Stack that is thread safe if the optional threadSafe parameter is set to true.