stack

Documentation

Index

• type Option
  • func WithContainer(c container.Container) Option
  • func WithGoroutineSafe() Option
  • func WithListContainer() Option
• type Options
• type Stack
  • func New(opts ...Option) *Stack
  • func (s *Stack) Clear()
  • func (s *Stack) Empty() bool
  • func (s *Stack) Pop() interface{}
  • func (s *Stack) Push(value interface{})
  • func (s *Stack) Size() int
  • func (s *Stack) String() string
  • func (s *Stack) Top() interface{}

Types

type Option

type Option func(option *Options)

Option is a function type used to set Options

func WithContainer

func WithContainer(c container.Container) Option

WithContainer is used to set a stack's underlying container

func WithGoroutineSafe

func WithGoroutineSafe() Option

WithGoroutineSafe is used to set a stack goroutine-safe

func WithListContainer

func WithListContainer() Option

WithListContainer is used to set List for a stack's underlying container

type Options

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

Options holds the Stack's options

type Stack

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

Stack is a last-in-first-out data structure

func New

func New(opts ...Option) *Stack

New creates a new stack

func (*Stack) Clear

func (s *Stack) Clear()

Clear clears all elements in the stack

func (*Stack) Empty

func (s *Stack) Empty() bool

Empty returns true if the stack is empty, otherwise returns false

func (*Stack) Pop

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

Pop removes the the top value in the stack and returns it

func (*Stack) Push

func (s *Stack) Push(value interface{})

Push pushes a value to the stack

func (*Stack) Size

func (s *Stack) Size() int

Size returns the amount of elements in the stack

func (*Stack) String

func (s *Stack) String() string

String returns a string representation of the stack

func (*Stack) Top

func (s *Stack) Top() interface{}

Top returns the top value in the stack