stack

Documentation

Index

• type Stack
  • func NewStack[T any](capacity int) *Stack[T]
  • func (s *Stack[T]) Capacity() int
  • func (s *Stack[T]) Count() int
  • func (s *Stack[T]) Peek() (bool, T)
  • func (s *Stack[T]) Pop() (bool, T)
  • func (s *Stack[T]) Push(value T) error

Types

type Stack

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

Stack is our type that implements a stack of data items

func NewStack

func NewStack[T any](capacity int) *Stack[T]

NewStack creates a new instance of a stack with an initial capacity

func (*Stack[T]) Capacity

func (s *Stack[T]) Capacity() int

Capacity is the capacity of this stack. Stacks can grow until memory is depleted today.

func (*Stack[T]) Count

func (s *Stack[T]) Count() int

Count of the data inside the stack

func (*Stack[T]) Peek

func (s *Stack[T]) Peek() (bool, T)

Peek the item that would be returned from pop. Note that for LIFO situations the list consumer must mutex, otherwise the next Pop may yield a different element

func (*Stack[T]) Pop

func (s *Stack[T]) Pop() (bool, T)

Pop a value from the stack

func (*Stack[T]) Push

func (s *Stack[T]) Push(value T) error

Push a value into the stack