vmstate

Documentation

Overview

Package vmstate contains a set of VM state flags along with appropriate type. It provides a set of conversion/marshaling functions/methods for this type as well. This package is made to make VM state reusable across all of the other components that need it without importing whole VM package.

Index

• type State
  • func FromString(s string) (st State, err error)
  • func (s State) HasFlag(f State) bool
  • func (s State) MarshalJSON() (data []byte, err error)
  • func (s State) String() string
  • func (s *State) UnmarshalJSON(data []byte) (err error)

Types

type State

type State uint8

State of the VM. It's a set of flags stored in the integer number.

const (
	// Halt represents HALT VM state (finished normally).
	Halt State = 1 << iota
	// Fault represents FAULT VM state (finished with an error).
	Fault
	// Break represents BREAK VM state (running, debug mode).
	Break
	// None represents NONE VM state (not started yet).
	None State = 0
)

Available States.

func FromString

func FromString(s string) (st State, err error)

FromString converts a string into the State.

func (State) HasFlag

func (s State) HasFlag(f State) bool

HasFlag checks for State flag presence.

func (State) MarshalJSON

func (s State) MarshalJSON() (data []byte, err error)

MarshalJSON implements the json.Marshaler interface.

func (State) String

func (s State) String() string

String implements the fmt.Stringer interface.

func (*State) UnmarshalJSON

func (s *State) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON implements the json.Marshaler interface.