stack

Documentation

Overview

Package stack provides a thread-safe stack implementation.

Index

• type Stack
  • func NewStack(cap int, bounded bool) *Stack
  • func (s *Stack) IsEmpty() bool
  • func (s *Stack) Peek() (interface{}, bool)
  • func (s *Stack) Pop() (interface{}, bool)
  • func (s *Stack) Push(item interface{}) error
  • func (s *Stack) Reset()
  • func (s *Stack) Size() int

Types

type Stack

type Stack struct {
	// contains filtered or unexported fields
}

Stack is a thread-safe LIFO data structure.

func NewStack

func NewStack(cap int, bounded bool) *Stack

NewStack returns a new stack with its initial capacity equal to the received size and bounded set accordingly.

func (*Stack) IsEmpty

func (s *Stack) IsEmpty() bool

IsEmpty returns whether or not the stack is empty

func (*Stack) Peek

func (s *Stack) Peek() (interface{}, bool)

Peek returns the item at the top of the stack without popping it. If the stack is empty, it will return nil

func (*Stack) Pop

func (s *Stack) Pop() (interface{}, bool)

Pop pops an item off the stack {}. A nil wil be returned if the stack is empty

func (*Stack) Push

func (s *Stack) Push(item interface{}) error

Push an item on the stack. An error will occur is the stack is bounded and at capacity.

func (*Stack) Reset

func (s *Stack) Reset()

Reset restets the stack: the capacity of the stack will be reset to its initial capacity. Anything in the queue will be lost

func (*Stack) Size

func (s *Stack) Size() int

Size returns the current size of the stack (number of items)