stacker

README

Stacker

A Go (and TinyGo) stack implementation shared by a few of my projects.

Based on

Something I saw at https://stackoverflow.com/questions/28541609/looking-for-reasonable-stack-implementation-in-golang

Testing

There are tests, just use go test ./... to run them.

Documentation

Index

• type Stacker
  • func NewStacker[Type any]() *Stacker[Type]
  • func (stacker *Stacker[Type]) Length() int
  • func (stacker *Stacker[Type]) Peek() (Type, error)
  • func (stacker *Stacker[Type]) Pop() (Type, error)
  • func (stacker *Stacker[Type]) Push(element Type)

Types

type Stacker

type Stacker[Type any] struct {
	Data []Type
	// contains filtered or unexported fields
}

----------------------------------------------------------------------------

func NewStacker

func NewStacker[Type any]() *Stacker[Type]

----------------------------------------------------------------------------

func (*Stacker[Type]) Length

func (stacker *Stacker[Type]) Length() int

---------------------------------------------------------------------------- Returns the number of elements in the stack

func (*Stacker[Type]) Peek

func (stacker *Stacker[Type]) Peek() (Type, error)

---------------------------------------------------------------------------- Returns the first entry in the stack, does not remove it, can error on empty

func (*Stacker[Type]) Pop

func (stacker *Stacker[Type]) Pop() (Type, error)

---------------------------------------------------------------------------- Pops and returns the first item on the stack, possibly error if the stack is empty

func (*Stacker[Type]) Push

func (stacker *Stacker[Type]) Push(element Type)

---------------------------------------------------------------------------- Pushed a new item into the stack